summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2022-04-14 12:39:12 (GMT)
committerBrad King <brad.king@kitware.com>2022-05-05 13:43:39 (GMT)
commit0aea13d20bc638ac896d5e0e817c6bd4f20e0770 (patch)
tree228c8d361a4d5546f484cd41bc5e2b35a0a38069 /Help/manual/cmake.1.rst
parentcc97725137783d4f6be3d513c14b975099319863 (diff)
downloadCMake-0aea13d20bc638ac896d5e0e817c6bd4f20e0770.zip
CMake-0aea13d20bc638ac896d5e0e817c6bd4f20e0770.tar.gz
CMake-0aea13d20bc638ac896d5e0e817c6bd4f20e0770.tar.bz2
Help: for message(FATAL_ERROR), document nonzero exit code
Diffstat (limited to 'Help/manual/cmake.1.rst')
-rw-r--r--Help/manual/cmake.1.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index cae8798..5ac21c8 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -1065,9 +1065,10 @@ To view the presets available for a project, use
Return Value (Exit Code)
========================
-Upon regular termination, the **cmake** executable returns the exit code 0.
+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.
+or another error condition, then a non-zero exit code is returned.
See Also