summaryrefslogtreecommitdiff
path: root/share/cmake-3.5/Help/command/message.rst
diff options
context:
space:
mode:
authorPavel Labath <labath@google.com>2016-05-17 10:02:28 +0100
committerPavel Labath <labath@google.com>2016-05-18 16:41:34 +0000
commit2558e7154fe7da69d90c6f99632a84b624a90a9a (patch)
tree01b6efc8719b523e315cc868d31f203602f385f7 /share/cmake-3.5/Help/command/message.rst
parent091caafda44f7fe52a94387b2eafcf204ea909d3 (diff)
downloadlinux-x86-2558e7154fe7da69d90c6f99632a84b624a90a9a.tar.gz
source: go/ab/2846898 Change-Id: I762a07bd4ff86251b349d36ae9359256204cd313
Diffstat (limited to 'share/cmake-3.5/Help/command/message.rst')
-rw-r--r--share/cmake-3.5/Help/command/message.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/share/cmake-3.5/Help/command/message.rst b/share/cmake-3.5/Help/command/message.rst
new file mode 100644
index 0000000..04c62fd
--- /dev/null
+++ b/share/cmake-3.5/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.