diff options
| author | Brad King <brad.king@kitware.com> | 2022-05-05 16:50:51 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2022-05-05 16:51:47 (GMT) |
| commit | 8a406805246efb0a25a9182b2805fd9a9a379b86 (patch) | |
| tree | 459a3d60b9fa8736f40c379c1bba0d05f91e4b53 /Help/manual/cmake.1.rst | |
| parent | 213f3917155ebe70b312c94cd8031bafa82c7215 (diff) | |
| parent | 0aea13d20bc638ac896d5e0e817c6bd4f20e0770 (diff) | |
| download | CMake-8a406805246efb0a25a9182b2805fd9a9a379b86.zip CMake-8a406805246efb0a25a9182b2805fd9a9a379b86.tar.gz CMake-8a406805246efb0a25a9182b2805fd9a9a379b86.tar.bz2 | |
Merge topic 'HelpExit'
0aea13d20b Help: for message(FATAL_ERROR), document nonzero exit code
cc97725137 Help: document exit code of command cmake(1)
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7175
Diffstat (limited to 'Help/manual/cmake.1.rst')
| -rw-r--r-- | Help/manual/cmake.1.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 3c5c46c..e0cb708 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -1061,6 +1061,18 @@ 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)`, +or another error condition, then a non-zero exit code is returned. + + See Also ======== |