Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,7 @@

## Build requirements

- CMake >= 3.28
- Ninja
- Clang 21
- ccache (optional, speeds up incremental builds)
- Boost (`libboost-dev`, `libboost-context-dev`, `libboost-program-options-dev`)

GTest, Google Benchmark, libbacktrace, liburing, and librseq are bundled as
submodules under `contrib/` and do not need to be installed separately.
See [README.md](README.md#requirements) for the full list of build dependencies.

Initialize the required submodules after cloning:

Expand All @@ -22,6 +15,29 @@ git submodule update --init --depth=1 \
contrib/benchmark
```

To build optional components, initialize their submodules too:

```
# http-perf (requires Poco)
git submodule update --init --depth=1 contrib/poco

# s3-perf (requires AWS SDK and its nested submodule)
git submodule update --init --depth=1 contrib/aws-sdk-cpp
git submodule update --init --depth=1 --recursive contrib/aws-sdk-cpp

# jemalloc (used by http-perf and s3-perf for improved allocator performance)
git submodule update --init --depth=1 contrib/jemalloc
```

Then pass the relevant flags to `configure`:

```
./bb configure --build-poco
./bb configure --build-aws
./bb configure --build-jemalloc
./bb configure --build-poco --build-aws --build-jemalloc
```

## Running tests

Configure and run all tests with:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ A cooperative fiber scheduler for Linux with per-CPU scheduler threads, io_uring
- Clang 21
- ccache (optional)
- Boost (`libboost-dev`, `libboost-context-dev`, `libboost-program-options-dev`)
- libbpf (`libbpf-dev`) — optional, required only for `src/profiler`; the profiler is silently skipped if absent

GTest, Google Benchmark, libbacktrace, liburing, and librseq are bundled as submodules under `contrib/` and do not need to be installed separately. Poco, the AWS SDK, and jemalloc are built on demand via `--build-poco`, `--build-aws`, and `--build-jemalloc` passed to `configure`.

Expand Down
Loading