summaryrefslogtreecommitdiffstats
path: root/Help/command/message.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/message.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/message.rst')
-rw-r--r--Help/command/message.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/Help/command/message.rst b/Help/command/message.rst
new file mode 100644
index 0000000..a20325a
--- /dev/null
+++ b/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.