summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2022-04-14 12:27:38 (GMT)
committerJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2022-05-04 12:17:01 (GMT)
commitcc97725137783d4f6be3d513c14b975099319863 (patch)
treef6867458920882574d9cb2ec6ea7539a4366721e /Help/manual
parent3d1d7d2b388e8b046fcd8cbb21863a4edfe8de8a (diff)
downloadCMake-cc97725137783d4f6be3d513c14b975099319863.zip
CMake-cc97725137783d4f6be3d513c14b975099319863.tar.gz
CMake-cc97725137783d4f6be3d513c14b975099319863.tar.bz2
Help: document exit code of command cmake(1)
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake.1.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 3ef7b3f..cae8798 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -1059,6 +1059,17 @@ To view the presets available for a project, use
cmake <source-dir> --list-presets
+
+.. _`CMake Exit Code`:
+
+Return Value (Exit Code)
+========================
+
+Upon regular termination, the **cmake** executable returns the exit code 0.
+If termination is caused by the command :command:`message(FATAL_ERROR)`,
+then a non-zero exit code is returned.
+
+
See Also
========