Skip to content

Commit e71a68b

Browse files
nuruponurupo
committed
docs: Update the list of CMake options
- Sorted - Added missing FLAT_OUTPUT_STRUCTURE - Added missing PROXY_TEST - Removed no longer existing EXECUTION_TRACE - Updated some option descriptions and made them match CMakeLists.txt
1 parent 77e0887 commit e71a68b

File tree

2 files changed

+39
-25
lines changed

2 files changed

+39
-25
lines changed

‎CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,13 @@ if(NOT USE_IPV6)
143143
add_definitions(-DUSE_IPV6=0)
144144
endif()
145145

146-
option(BUILD_MISC_TESTS "Build additional tests and utilities" OFF)
146+
option(BUILD_MISC_TESTS "Build additional tests" OFF)
147147
option(BUILD_FUN_UTILS "Build additional just for fun utilities" OFF)
148148

149149
option(AUTOTEST "Enable autotests (mainly for CI)" OFF)
150150
if(AUTOTEST)
151151
option(NON_HERMETIC_TESTS "Whether to build and run tests that depend on an internet connection" OFF)
152-
option(PROXY_TEST "Enable proxy test (needs HTTP/SOCKS5 proxy on port 8080/8081)" OFF)
152+
option(PROXY_TEST "Enable proxy test (requires other/proxy/proxy_server.go to be running)" OFF)
153153
endif()
154154

155155
option(BUILD_TOXAV "Whether to build the tox AV library" ON)

‎INSTALL.md‎

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -128,32 +128,39 @@ components, so your mileage might vary.
128128

129129
There are some options that are available to configure the build.
130130

131-
| Name | Description | Expected Value | Default Value |
132-
| ---------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------- |
133-
| `AUTOTEST` | Enable autotests (mainly for CI). | ON or OFF | OFF |
134-
| `BOOTSTRAP_DAEMON` | Enable building of tox-bootstrapd, the DHT bootstrap node daemon. For Unix-like systems only. | ON or OFF | ON |
135-
| `BUILD_FUZZ_TESTS` | Build fuzzing harnesses. | ON or OFF | OFF |
136-
| `BUILD_MISC_TESTS` | Build additional tests. | ON or OFF | OFF |
137-
| `BUILD_FUN_UTILS` | Build additional funny utilities. | ON or OFF | OFF |
138-
| `BUILD_TOXAV` | Whether to build the toxav library. | ON or OFF | ON |
139-
| `CMAKE_INSTALL_PREFIX` | Path to where everything should be installed. | Directory path. | Platform-dependent. Refer to CMake documentation. |
140-
| `CMAKE_BUILD_TYPE` | Specifies the build type on single-configuration generators (e.g. make or ninja). | Debug, Release, RelWithDebInfo, MinSizeRel | Empty string. |
141-
| `DHT_BOOTSTRAP` | Enable building of `DHT_bootstrap` | ON or OFF | ON |
142-
| `ENABLE_SHARED` | Build shared (dynamic) libraries for all modules. | ON or OFF | ON |
143-
| `ENABLE_STATIC` | Build static libraries for all modules. | ON or OFF | ON |
144-
| `EXECUTION_TRACE` | Print a function trace during execution (for debugging). | ON or OFF | OFF |
145-
| `FULLY_STATIC` | Build fully static executables. | ON or OFF | OFF |
146-
| `MIN_LOGGER_LEVEL` | Logging level to use. | TRACE, DEBUG, INFO, WARNING, ERROR or nothing (empty string) for default. | Empty string. |
147-
| `MSVC_STATIC_SODIUM` | Whether to link libsodium statically for MSVC. | ON or OFF | OFF |
148-
| `MUST_BUILD_TOXAV` | Fail the build if toxav cannot be built. | ON or OFF | OFF |
149-
| `NON_HERMETIC_TESTS` | Whether to build and run tests that depend on an internet connection. | ON or OFF | OFF |
150-
| `EXPERIMENTAL_API` | Install the experimental private API header. | ON or OFF | OFF |
151-
| `STRICT_ABI` | Enforce strict ABI export in dynamic libraries. | ON or OFF | OFF |
152-
| `TEST_TIMEOUT_SECONDS` | Limit runtime of each test to the number of seconds specified. | Positive number or nothing (empty string). | Empty string. |
153-
| `USE_IPV6` | Use IPv6 in tests. | ON or OFF | ON |
131+
| Name | Description | Expected Value | Default Value |
132+
| ----------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------- |
133+
| `AUTOTEST` | Enable autotests (mainly for CI). | ON or OFF | OFF |
134+
| `BOOTSTRAP_DAEMON` | Enable building of tox-bootstrapd, the DHT bootstrap node daemon. For Unix-like systems only. | ON or OFF | ON |
135+
| `BUILD_FUN_UTILS` | Build additional just for fun utilities. | ON or OFF | OFF |
136+
| `BUILD_FUZZ_TESTS` | Build fuzzing harnesses. | ON or OFF | OFF |
137+
| `BUILD_MISC_TESTS` | Build additional tests. | ON or OFF | OFF |
138+
| `BUILD_TOXAV` | Whether to build the toxav library. | ON or OFF | ON |
139+
| `CMAKE_BUILD_TYPE` | Specifies the build type on single-configuration generators (e.g. make or ninja). | Debug, Release, RelWithDebInfo, MinSizeRel | Empty string. |
140+
| `CMAKE_INSTALL_PREFIX` | Path to where everything should be installed. | Directory path. | Platform-dependent. Refer to CMake documentation. |
141+
| `DHT_BOOTSTRAP` | Enable building of `DHT_bootstrap`. | ON or OFF | ON |
142+
| `ENABLE_SHARED` | Build shared (dynamic) libraries for all modules. | ON or OFF | ON |
143+
| `ENABLE_STATIC` | Build static libraries for all modules. | ON or OFF | ON |
144+
| `EXPERIMENTAL_API` | Install experimental header file with unstable API. | ON or OFF | OFF |
145+
| `FLAT_OUTPUT_STRUCTURE` | Whether to produce output artifacts in {bin,lib}. | ON or OFF | OFF |
146+
| `FULLY_STATIC` | Build fully static executables. | ON or OFF | OFF |
147+
| `MIN_LOGGER_LEVEL` | Logging level to use. | TRACE, DEBUG, INFO, WARNING, ERROR or nothing (empty string) for default. | Empty string. |
148+
| `MSVC_STATIC_SODIUM` | Whether to link libsodium statically for MSVC. | ON or OFF | OFF |
149+
| `MUST_BUILD_TOXAV` | Fail the build if toxav cannot be built. | ON or OFF | OFF |
150+
| `NON_HERMETIC_TESTS` | Whether to build and run tests that depend on an internet connection. | ON or OFF | OFF |
151+
| `PROXY_TEST` | Enable proxy test (requires `other/proxy/proxy_server.go` to be running). | ON or OFF | OFF |
152+
| `STRICT_ABI` | Enforce strict ABI export in dynamic libraries. | ON or OFF | OFF |
153+
| `TEST_TIMEOUT_SECONDS` | Limit runtime of each test to the number of seconds specified. | Positive number or nothing (empty string). | Empty string. |
154+
| `USE_IPV6` | Use IPv6 in tests. | ON or OFF | ON |
154155

155156
You can get this list of option using the following commands
156157

158+
```sh
159+
cmake -B _build -LAH
160+
```
161+
162+
or
163+
157164
```sh
158165
grep "option(" CMakeLists.txt cmake/*
159166
grep "set(.* CACHE" CMakeLists.txt cmake/*
@@ -195,6 +202,13 @@ make
195202
make install
196203
```
197204

205+
or shorter
206+
207+
```sh
208+
cmake -B _build
209+
cmake -B _build --target install
210+
```
211+
198212
#### Windows
199213

200214
##### Building on Windows host

0 commit comments

Comments
 (0)