summaryrefslogtreecommitdiffstats
path: root/Help/command/message.rst
diff options
context:
space:
mode:
authorNikita Nemkin <nikita@nemkin.ru>2020-11-07 20:30:30 (GMT)
committerNikita Nemkin <nikita@nemkin.ru>2020-11-09 15:51:57 (GMT)
commitc705279bae45c85b689febd66d5437d9ec05c9b9 (patch)
treef64bca14f17a902a96d67a30357df3d1e6c745eb /Help/command/message.rst
parent63a1917d098922b59bbba8fdeb42519363d5ba0d (diff)
downloadCMake-c705279bae45c85b689febd66d5437d9ec05c9b9.zip
CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.gz
CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.bz2
Help: Add `.. versionadded` directives to commands documentation
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
Diffstat (limited to 'Help/command/message.rst')
-rw-r--r--Help/command/message.rst47
1 files changed, 28 insertions, 19 deletions
diff --git a/Help/command/message.rst b/Help/command/message.rst
index 6bc0e4c..3ea82a6 100644
--- a/Help/command/message.rst
+++ b/Help/command/message.rst
@@ -71,6 +71,9 @@ influences the way the message is handled:
using this log level would normally only be temporary and would expect to be
removed before releasing the project, packaging up the files, etc.
+.. versionadded:: 3.15
+ Added ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels.
+
The CMake command-line tool displays ``STATUS`` to ``TRACE`` messages on stdout
with the message preceded by two hyphens and a space. All other message types
are sent to stderr and are not prefixed with hyphens. The
@@ -79,25 +82,29 @@ The :manual:`curses interface <ccmake(1)>` shows ``STATUS`` to ``TRACE``
messages one at a time on a status line and other messages in an
interactive pop-up box. The ``--log-level`` command-line option to each of
these tools can be used to control which messages will be shown.
-To make a log level persist between CMake runs, the
-:variable:`CMAKE_MESSAGE_LOG_LEVEL` variable can be set instead.
-Note that the command line option takes precedence over the cache variable.
-
-Messages of log levels ``NOTICE`` and below will have each line preceded
-by the content of the :variable:`CMAKE_MESSAGE_INDENT` variable (converted to
-a single string by concatenating its list items). For ``STATUS`` to ``TRACE``
-messages, this indenting content will be inserted after the hyphens.
-
-Messages of log levels ``NOTICE`` and below can also have each line preceded
-with context of the form ``[some.context.example]``. The content between the
-square brackets is obtained by converting the :variable:`CMAKE_MESSAGE_CONTEXT`
-list variable to a dot-separated string. The message context will always
-appear before any indenting content but after any automatically added leading
-hyphens. By default, message context is not shown, it has to be explicitly
-enabled by giving the :manual:`cmake <cmake(1)>` ``--log-context``
-command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW`
-variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for
-usage examples.
+
+.. versionadded:: 3.17
+ To make a log level persist between CMake runs, the
+ :variable:`CMAKE_MESSAGE_LOG_LEVEL` variable can be set instead.
+ Note that the command line option takes precedence over the cache variable.
+
+.. versionadded:: 3.16
+ Messages of log levels ``NOTICE`` and below will have each line preceded
+ by the content of the :variable:`CMAKE_MESSAGE_INDENT` variable (converted to
+ a single string by concatenating its list items). For ``STATUS`` to ``TRACE``
+ messages, this indenting content will be inserted after the hyphens.
+
+.. versionadded:: 3.17
+ Messages of log levels ``NOTICE`` and below can also have each line preceded
+ with context of the form ``[some.context.example]``. The content between the
+ square brackets is obtained by converting the :variable:`CMAKE_MESSAGE_CONTEXT`
+ list variable to a dot-separated string. The message context will always
+ appear before any indenting content but after any automatically added leading
+ hyphens. By default, message context is not shown, it has to be explicitly
+ enabled by giving the :manual:`cmake <cmake(1)>` ``--log-context``
+ command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW`
+ variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for
+ usage examples.
CMake Warning and Error message text displays using a simple markup
language. Non-indented text is formatted in line-wrapped paragraphs
@@ -107,6 +114,8 @@ delimited by newlines. Indented text is considered pre-formatted.
Reporting checks
^^^^^^^^^^^^^^^^
+.. versionadded:: 3.17
+
A common pattern in CMake output is a message indicating the start of some
sort of check, followed by another message reporting the result of that check.
For example: