about summary refs log tree commit diff
path: root/doc/hooks/cmake.section.md
diff options
context:
space:
mode:
authorRobert Hensing <robert@roberthensing.nl>2022-10-13 15:36:04 +0200
committerRobert Hensing <robert@roberthensing.nl>2022-10-13 15:40:27 +0200
commit2db8de920eebf9ef488c4725d579a2c3862d9a04 (patch)
tree11273414bf1ed05cc3ef1745f397a96702a45a1b /doc/hooks/cmake.section.md
parent5b055190e37d220b787b304e400391299bba022c (diff)
downloadnixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar.gz
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar.bz2
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar.lz
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar.xz
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.tar.zst
nixlib-2db8de920eebf9ef488c4725d579a2c3862d9a04.zip
doc: Move non-stdenv hooks out of stdenv chapter
Diffstat (limited to 'doc/hooks/cmake.section.md')
-rw-r--r--doc/hooks/cmake.section.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/hooks/cmake.section.md b/doc/hooks/cmake.section.md
new file mode 100644
index 000000000000..58fbfa45a2e0
--- /dev/null
+++ b/doc/hooks/cmake.section.md
@@ -0,0 +1,4 @@
+
+### cmake {#cmake}
+
+Overrides the default configure phase to run the CMake command. By default, we use the Make generator of CMake. In addition, dependencies are added automatically to `CMAKE_PREFIX_PATH` so that packages are correctly detected by CMake. Some additional flags are passed in to give similar behavior to configure-based packages. You can disable this hook’s behavior by setting `configurePhase` to a custom value, or by setting `dontUseCmakeConfigure`. `cmakeFlags` controls flags passed only to CMake. By default, parallel building is enabled as CMake supports parallel building almost everywhere. When Ninja is also in use, CMake will detect that and use the ninja generator.