summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-10 13:21:36 (GMT)
committerBrad King <brad.king@kitware.com>2019-10-10 13:21:36 (GMT)
commit580e322dcbc3cfe8cbe08491564fe2aeb727b811 (patch)
tree0579597d243cb6e91c1ac0421697507df3876580 /Help
parente5419f4f873d8c233c9903a813866bc0c759dfc9 (diff)
parent7bbddeb78d46193eda9c2a948040e50012fbe33b (diff)
downloadCMake-580e322dcbc3cfe8cbe08491564fe2aeb727b811.zip
CMake-580e322dcbc3cfe8cbe08491564fe2aeb727b811.tar.gz
CMake-580e322dcbc3cfe8cbe08491564fe2aeb727b811.tar.bz2
Merge branch 'rename_loglevel_option' into release-3.16
Merge-request: !3899
Diffstat (limited to 'Help')
-rw-r--r--Help/command/message.rst2
-rw-r--r--Help/manual/cmake.1.rst5
-rw-r--r--Help/release/3.16.rst5
3 files changed, 10 insertions, 2 deletions
diff --git a/Help/command/message.rst b/Help/command/message.rst
index 3002842..c614286 100644
--- a/Help/command/message.rst
+++ b/Help/command/message.rst
@@ -57,7 +57,7 @@ are sent to stderr and are not prefixed with hyphens. The
:manual:`CMake GUI <cmake-gui(1)>` displays all messages in its log area.
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 ``--loglevel`` command-line option to each of
+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.
Messages of log levels ``NOTICE`` and below will also have each line preceded
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 754f14b..4ab55a0 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -200,12 +200,15 @@ Options
from the top of a binary tree for a CMake project it will dump
additional information such as the cache, log files etc.
-``--loglevel=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>``
+``--log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>``
Set the log level.
The :command:`message` command will only output messages of the specified
log level or higher. The default log level is ``STATUS``.
+ For backward compatibility reasons, ``--loglevel`` is also accepted as a
+ synonym for this option.
+
``--debug-trycompile``
Do not delete the :command:`try_compile` build tree.
Only useful on one :command:`try_compile` at a time.
diff --git a/Help/release/3.16.rst b/Help/release/3.16.rst
index 2b1ecf5..a14effe 100644
--- a/Help/release/3.16.rst
+++ b/Help/release/3.16.rst
@@ -56,6 +56,11 @@ Command-Line
option that can be used to redirect ``--trace`` output to a file instead
of ``stderr``.
+* The :manual:`cmake(1)` ``--loglevel`` command line option has been
+ renamed to ``--log-level`` to make it consistent with the naming of other
+ command line options. The ``--loglevel`` option is still supported to
+ preserve backward compatibility.
+
Commands
--------