mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-24 05:03:26 +08:00
c2efb3efcd
Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
34 lines
1.2 KiB
ReStructuredText
34 lines
1.2 KiB
ReStructuredText
message
|
|
-------
|
|
|
|
Display a message to the user.
|
|
|
|
.. code-block:: cmake
|
|
|
|
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.
|