Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document optional dependency CMake build options #173

Merged
merged 2 commits into from
Apr 18, 2022
Merged

Document optional dependency CMake build options #173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbb291c
Document optional CMake build options
jiridanek Mar 12, 2022
604b41d
remove jemalloc doc
jiridanek Apr 4, 2022
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
14 changes: 14 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,4 +311,18 @@ Older versions of `CMake`` only honor this option with the Intel compiler on Lin
This option *breaks* safe pointers, resulting in crashes, therefore is suitable only for debugging.
When combined with `-DRUNTIME_CHECK=asan`, the pointer breakages are much less frequent.

|`-DBUILD_TESTING=OFF`
|Excludes project's tests from the build.

|`-DBUILD_BENCHMARKS=ON`
|Benchmarking tests will be built.
The `libbenchmark` library is required by the benchmarks.

|===

==== Optional dependencies

The following CMake options can be used to force-enable (or force-disable) the use of optional dependencies:

- `-DUSE_LIBNGHTTP2`, for the libnghttp2 library, needed by the http2 protocol adaptor
- `-DUSE_LIBWEBSOCKETS`, for the libwebsockets library, needed to configure `http: yes` listeners