Skip to content

Commit

Permalink
Document optional CMake build options
Browse files Browse the repository at this point in the history
  • Loading branch information
jiridanek committed Mar 12, 2022
1 parent 0e2c88b commit 24cb19c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -311,4 +311,22 @@ 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.

|`-DUSE_JEMALLOC=ON`
|The jemalloc library will be linked, replacing the standard C library memory allocation functions with
its own optimized implementations.

|===

==== 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

0 comments on commit 24cb19c

Please sign in to comment.