mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-01 19:30:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: for message(FATAL_ERROR), document nonzero exit code

Browse Source
This commit is contained in:
Joachim Wuttke (h)
2022-04-14 14:39:12 +02:00
committed by Brad King
parent cc97725137
commit 0aea13d20b
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Help/command/message.rst
View File

@@ -32,6 +32,9 @@ influences the way the message is handled:
``FATAL_ERROR``
CMake Error, stop processing and generation.
The :manual:`cmake(1)` executable will return a non-zero
:ref:`exit code <CMake Exit Code>`.
``SEND_ERROR``
CMake Error, continue processing, but skip generation.

5
Help/manual/cmake.1.rst
View File

@@ -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