From 5e23a98d51817ea9c092fd6c293163c097519edd Mon Sep 17 00:00:00 2001 From: cheezecat Date: Mon, 4 Jun 2018 03:38:44 -0700 Subject: [PATCH] Document default behavior for a bare cmake invocation (#23) * Document default behavior for a bare cmake invocation * Clarify how to specify cmake options * Doc default cmake build type If I was better with cmake I would change the cmake default to release * Add doc for existing options in cmake --- docs/devs/building/unix.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/devs/building/unix.md b/docs/devs/building/unix.md index 27e3103..608510a 100644 --- a/docs/devs/building/unix.md +++ b/docs/devs/building/unix.md @@ -34,18 +34,22 @@ After successful build i2pd could be installed with: CMake Options ------------- -Available CMake options(each option has a form of `=`, for more information see `man 1 cmake`): - -* `CMAKE_BUILD_TYPE` build profile (Debug/Release) -* `WITH_BINARY` build i2pd itself -* `WITH_LIBRARY` build libi2pd -* `WITH_STATIC` build static versions of library and i2pd binary -* `WITH_UPNP` build with UPnP support (requires libminiupnp) -* `WITH_AESNI` build with AES-NI support (ON/OFF) -* `WITH_HARDENING` enable hardening features (ON/OFF) (gcc only) -* `WITH_PCH` use pre-compiled header (experimental, speeds up build) -* `WITH_I2LUA` used when building i2lua -* `WITH_WEBSOCKETS` enable websocket server +Available CMake options(each option has a form of `-D=`, for more information see `man 1 cmake`): + +* `CMAKE_BUILD_TYPE` build profile (Debug/Release, default: no optimization or debug symbols) +* `WITH_BINARY` build i2pd itself (default: ON) +* `WITH_LIBRARY` build libi2pd (default: ON) +* `WITH_STATIC` build static versions of library and i2pd binary (default: OFF) +* `WITH_UPNP` build with UPnP support (requires libminiupnp, default: OFF) +* `WITH_AESNI` build with AES-NI support (default: OFF) +* `WITH_HARDENING` enable hardening features (gcc only, default: OFF) +* `WITH_PCH` use pre-compiled header (experimental, speeds up build, default: OFF) +* `WITH_I2LUA` used when building i2lua (default: OFF) +* `WITH_WEBSOCKETS` enable websocket server (default: OFF) +* `WITH_AVX` build with AVX support (default: OFF) +* `WITH_MESHNET` build for cjdns test network (default: OFF) +* `WITH_ADDRSANITIZER` build with Address Sanitizer (default: OFF) +* `WITH_THREADSANITIZER` build with Thread Sanitizer (default: OFF) Also there is `-L` flag for CMake that could be used to list current cached options: