diff options
Diffstat (limited to 'share/cmake-3.10/Help/command/message.rst')
| -rw-r--r-- | share/cmake-3.10/Help/command/message.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/share/cmake-3.10/Help/command/message.rst b/share/cmake-3.10/Help/command/message.rst new file mode 100644 index 0000000..04c62fd --- /dev/null +++ b/share/cmake-3.10/Help/command/message.rst @@ -0,0 +1,33 @@ +message +------- + +Display a message to the user. + +:: + + message([<mode>] "message to display" ...) + +The optional ``<mode>`` keyword determines the type of message: + +:: + + (none) = Important information + STATUS = Incidental information + WARNING = CMake Warning, continue processing + AUTHOR_WARNING = CMake Warning (dev), continue processing + SEND_ERROR = CMake Error, continue processing, + but skip generation + FATAL_ERROR = CMake Error, stop processing and generation + DEPRECATION = CMake Deprecation Error or Warning if variable + CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED + is enabled, respectively, else no message. + +The CMake command-line tool displays STATUS messages on stdout and all +other message types on stderr. The CMake GUI displays all messages in +its log area. The interactive dialogs (ccmake and CMakeSetup) show +STATUS messages one at a time on a status line and other messages in +interactive pop-up boxes. + +CMake Warning and Error message text displays using a simple markup +language. Non-indented text is formatted in line-wrapped paragraphs +delimited by newlines. Indented text is considered pre-formatted. |