PurpleI2P
/
i2pd_docs_en
mirror of https://github.com/PurpleI2P/i2pd_docs_en
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

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
pull/24/head
cheezecat 7 years ago committed by l-n-s
parent
f9a9716612
commit
5e23a98d51
1 changed files with 16 additions and 12 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 28
      docs/devs/building/unix.md

28
docs/devs/building/unix.md
Unescape View File

@ -34,18 +34,22 @@ After successful build i2pd could be installed with:
CMake Options CMake Options
------------- -------------
Available CMake options(each option has a form of `<key>=<value>`, for more information see `man 1 cmake`): Available CMake options(each option has a form of `-D<key>=<value>`, for more information see `man 1 cmake`):
* `CMAKE_BUILD_TYPE` build profile (Debug/Release) * `CMAKE_BUILD_TYPE` build profile (Debug/Release, default: no optimization or debug symbols)
* `WITH_BINARY` build i2pd itself * `WITH_BINARY` build i2pd itself (default: ON)
* `WITH_LIBRARY` build libi2pd * `WITH_LIBRARY` build libi2pd (default: ON)
* `WITH_STATIC` build static versions of library and i2pd binary * `WITH_STATIC` build static versions of library and i2pd binary (default: OFF)
* `WITH_UPNP` build with UPnP support (requires libminiupnp) * `WITH_UPNP` build with UPnP support (requires libminiupnp, default: OFF)
* `WITH_AESNI` build with AES-NI support (ON/OFF) * `WITH_AESNI` build with AES-NI support (default: OFF)
* `WITH_HARDENING` enable hardening features (ON/OFF) (gcc only) * `WITH_HARDENING` enable hardening features (gcc only, default: OFF)
* `WITH_PCH` use pre-compiled header (experimental, speeds up build) * `WITH_PCH` use pre-compiled header (experimental, speeds up build, default: OFF)
* `WITH_I2LUA` used when building i2lua * `WITH_I2LUA` used when building i2lua (default: OFF)
* `WITH_WEBSOCKETS` enable websocket server * `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: Also there is `-L` flag for CMake that could be used to list current cached options:

Write Preview
Loading…
Cancel
Save