summaryrefslogtreecommitdiffstats
path: root/Help/release
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2022-10-11 20:17:53 (GMT)
committerBrad King <brad.king@kitware.com>2022-10-12 13:29:48 (GMT)
commit26020fdaae466d5e285581c5abb1f59f21c235f0 (patch)
treec8cd70440e0348f0d873f3291ec99fdeace92355 /Help/release
parentc3ec1b741189c218173f9a69d6362a4414cbead2 (diff)
downloadCMake-26020fdaae466d5e285581c5abb1f59f21c235f0.zip
CMake-26020fdaae466d5e285581c5abb1f59f21c235f0.tar.gz
CMake-26020fdaae466d5e285581c5abb1f59f21c235f0.tar.bz2
Help: Reference options of sub-commands in some older release notes (>= 3.20)
Diffstat (limited to 'Help/release')
-rw-r--r--Help/release/3.20.rst4
-rw-r--r--Help/release/3.21.rst14
-rw-r--r--Help/release/3.23.rst11
-rw-r--r--Help/release/3.24.rst36
4 files changed, 36 insertions, 29 deletions
diff --git a/Help/release/3.20.rst b/Help/release/3.20.rst
index 42e95be..71f47c4 100644
--- a/Help/release/3.20.rst
+++ b/Help/release/3.20.rst
@@ -217,8 +217,8 @@ Autogen
CTest
-----
-* :manual:`ctest(1)` gained a ``--test-dir`` option to specify the directory
- in which to look for tests.
+* :manual:`ctest(1)` gained a :option:`--test-dir <ctest --test-dir>`
+ option to specify the directory in which to look for tests.
CPack
-----
diff --git a/Help/release/3.21.rst b/Help/release/3.21.rst
index 462d2be..91c3768 100644
--- a/Help/release/3.21.rst
+++ b/Help/release/3.21.rst
@@ -49,15 +49,15 @@ Languages
Command-Line
------------
-* :manual:`cmake(1)` gained the ``--install-prefix <dir>``
+* :manual:`cmake(1)` gained the :option:`--install-prefix <cmake --install-prefix>`
command-line option to specify the location of the install prefix.
-* :manual:`cmake(1)` gained the ``--toolchain <path/to/file>``
+* :manual:`cmake(1)` gained the :option:`--toolchain <cmake --toolchain>`
command-line option to specify a toolchain file.
-* :manual:`cmake(1)` ``-E capabilities`` output, for some generators,
- may now contain a ``supportedPlatforms`` field listing platforms
- known to be supported in :variable:`CMAKE_GENERATOR_PLATFORM`.
+* :manual:`cmake(1)` :option:`-E capabilities <cmake-E capabilities>` output,
+ for some generators, may now contain a ``supportedPlatforms`` field listing
+ platforms known to be supported in :variable:`CMAKE_GENERATOR_PLATFORM`.
* Messages printed to a terminal now may be colored by message type.
@@ -208,8 +208,8 @@ CTest
:prop_test:`ATTACHED_FILES_ON_FAIL` test properties.
See :ref:`Additional Test Measurements` for more information.
-* :manual:`ctest(1)` gained a ``--output-junit`` option to write test results
- to a JUnit XML file.
+* :manual:`ctest(1)` gained a :option:`--output-junit <ctest --output-junit>`
+ option to write test results to a JUnit XML file.
* The :command:`ctest_build` command gained a ``PARALLEL_LEVEL`` option.
diff --git a/Help/release/3.23.rst b/Help/release/3.23.rst
index 209be45..064616b 100644
--- a/Help/release/3.23.rst
+++ b/Help/release/3.23.rst
@@ -43,19 +43,22 @@ Generators
Command-Line
------------
-* The :manual:`cmake(1)` ``--build`` command, when used with
+* The :manual:`cmake(1)` :option:`--build <cmake --build>` command, when used with
:ref:`Visual Studio Generators` on projects that set the
:prop_tgt:`VS_PACKAGE_REFERENCES` target property, now automatically
restores package references from NuGet. The cache variable
:variable:`CMAKE_VS_NUGET_PACKAGE_RESTORE` may be set to toggle this behavior
- in a build tree. Use the ``--resolve-package-references=<on|off|only>``
+ in a build tree. Use the
+ :option:`--resolve-package-references <cmake--build --resolve-package-references>`
command-line option to control the behavior on one invocation.
-* The :manual:`cmake(1)` command line tool gained a ``--debug-find-pkg=``
+* The :manual:`cmake(1)` command line tool gained a
+ :option:`--debug-find-pkg <cmake --debug-find-pkg>`
option to enable debug messages under specific :command:`find_package`
calls.
-* The :manual:`cmake(1)` command line tool gained a ``--debug-find-var=``
+* The :manual:`cmake(1)` command line tool gained a
+ :option:`--debug-find-var <cmake --debug-find-var>`
option to enable debug messages for ``find_*`` calls that use specific
result variables.
diff --git a/Help/release/3.24.rst b/Help/release/3.24.rst
index 3857c5d..1d331d5 100644
--- a/Help/release/3.24.rst
+++ b/Help/release/3.24.rst
@@ -34,25 +34,28 @@ Generators
Command-Line
------------
-* :manual:`cmake(1)` gained the ``--fresh`` command-line option to remove
- any existing ``CMakeCache.txt`` file and associated ``CMakeFiles/``
+* :manual:`cmake(1)` gained the :option:`--fresh <cmake --fresh>` command-line
+ option to remove any existing ``CMakeCache.txt`` file and associated ``CMakeFiles/``
directory, when configuring a build tree, thus starting a new configuration
as if the build tree were freshly created.
-* :manual:`cmake(1)` gained the ``--compile-no-warning-as-error`` command-line
- option which causes the effects of the :prop_tgt:`COMPILE_WARNING_AS_ERROR`
- target property and :variable:`CMAKE_COMPILE_WARNING_AS_ERROR` variable
- to be ignored.
+* :manual:`cmake(1)` gained the
+ :option:`--compile-no-warning-as-error <cmake --compile-no-warning-as-error>`
+ command-line option which causes the effects of the
+ :prop_tgt:`COMPILE_WARNING_AS_ERROR` target property and
+ :variable:`CMAKE_COMPILE_WARNING_AS_ERROR` variable to be ignored.
-* The :manual:`cmake(1)` ``--trace=json-v1`` trace format gained fields
- ``global_frame`` and ``line_end``.
+* The :manual:`cmake(1)` :option:`--trace=json-v1 <cmake --trace>` trace
+ format gained fields ``global_frame`` and ``line_end``.
-* The :manual:`cmake(1)` ``-E`` commands ``cat`` and ``env`` learned to respect
- a double dash (``--``) argument that acts as a delimiter indicating the end of
- options. Any following arguments are treated as operands/positional arguments,
- even if they begin with a dash ``-`` character.
+* The :manual:`cmake(1)` :option:`-E <cmake -E>` commands :option:`cat <cmake-E cat>`
+ and :option:`env <cmake-E env>` learned to respect a double dash
+ (:option:`-- <cmake-E_env -->`) argument that acts as a delimiter indicating
+ the end of options. Any following arguments are treated as operands/positional
+ arguments, even if they begin with a dash ``-`` character.
-* The :manual:`cmake(1)` ``-E tar`` command gained the ``--touch`` option
+* The :manual:`cmake(1)` :option:`-E tar <cmake-E tar>` command gained the
+ :option:`--touch <cmake-E_tar --touch>` option
to keep the current local timestamp instead of extracting file timestamps
from the archive.
@@ -289,9 +292,10 @@ Generator Expressions
CTest
-----
-* :manual:`ctest(1)` gained a ``--test-output-truncation`` option (and
- corresponding :variable:`CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variable) to
- specify the truncation mode once the maximum test output size has been
+* :manual:`ctest(1)` gained a
+ :option:`--test-output-truncation <ctest --test-output-truncation>` option
+ (and corresponding :variable:`CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variable)
+ to specify the truncation mode once the maximum test output size has been
reached. Possible values are ``tail`` (default), ``middle`` or ``head``.
CPack