summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-12-03 13:48:57 (GMT)
committerKitware Robot <kwrobot@kitware.com>2020-12-03 13:49:25 (GMT)
commit0eead931a370eb136dd2723192528ddce7ca69d1 (patch)
tree556f3d0f592951d1d687349be9e5861172468605 /Help
parentd4992ca605149bbea2ec43d8dad5544063eec3f7 (diff)
parent5000f93a91a5a9f0964d415692ffc05df0114eb1 (diff)
downloadCMake-0eead931a370eb136dd2723192528ddce7ca69d1.zip
CMake-0eead931a370eb136dd2723192528ddce7ca69d1.tar.gz
CMake-0eead931a370eb136dd2723192528ddce7ca69d1.tar.bz2
Merge topic 'versionadded'
5000f93a91 Help: Fix grammar in `.. versionadded` directives 8fea95319b Help: Add `.. versionadded` directives to module docs 8634561dca Help: Improve formatting for FindBoost and FindCUDA ea59b0cd34 Help: Fix version note for CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE 05c3060b10 Help: Fix cmake_parse_arguments version note dafcef8b50 Help: Improve styling for versionadded/deprecated directives 6ae216daef Tests: Make RunCMake.CMP0106 expected output robust to line number changes Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5560
Diffstat (limited to 'Help')
-rw-r--r--Help/command/cmake_parse_arguments.rst6
-rw-r--r--Help/command/ctest_submit.rst10
-rw-r--r--Help/command/file.rst2
-rw-r--r--Help/command/find_package.rst2
-rw-r--r--Help/command/get_filename_component.rst2
-rw-r--r--Help/command/list.rst4
-rw-r--r--Help/command/message.rst2
-rw-r--r--Help/command/project.rst10
-rw-r--r--Help/command/string.rst4
-rw-r--r--Help/cpack_gen/deb.rst4
-rw-r--r--Help/cpack_gen/freebsd.rst2
-rw-r--r--Help/cpack_gen/ifw.rst4
-rw-r--r--Help/cpack_gen/rpm.rst6
-rw-r--r--Help/envvar/CUDAHOSTCXX.rst7
-rw-r--r--Help/generator/Green Hills MULTI.rst2
15 files changed, 39 insertions, 28 deletions
diff --git a/Help/command/cmake_parse_arguments.rst b/Help/command/cmake_parse_arguments.rst
index 8dedc80..7c85da6 100644
--- a/Help/command/cmake_parse_arguments.rst
+++ b/Help/command/cmake_parse_arguments.rst
@@ -1,8 +1,6 @@
cmake_parse_arguments
---------------------
-.. versionadded:: 3.5
-
Parse function or macro arguments.
.. code-block:: cmake
@@ -13,6 +11,10 @@ Parse function or macro arguments.
cmake_parse_arguments(PARSE_ARGV <N> <prefix> <options>
<one_value_keywords> <multi_value_keywords>)
+.. versionadded:: 3.5
+ This command is implemented natively. Previously, it has been defined in the
+ module :module:`CMakeParseArguments`.
+
This command is for use in macros or functions.
It processes the arguments given to that macro or function,
and defines a set of variables which hold the values of the
diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst
index 9c10318..e6d277f 100644
--- a/Help/command/ctest_submit.rst
+++ b/Help/command/ctest_submit.rst
@@ -115,16 +115,16 @@ to tell CDash which handler to use to process the data.
This signature interprets options in the same way as the first one.
.. versionadded:: 3.8
- Added ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
+ Added the ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
.. versionadded:: 3.9
- Added ``HTTPHEADER`` option.
+ Added the ``HTTPHEADER`` option.
.. versionadded:: 3.13
- Added ``RETURN_VALUE`` option.
+ Added the ``RETURN_VALUE`` option.
.. versionadded:: 3.14
- Added ``SUBMIT_URL`` option.
+ Added the ``SUBMIT_URL`` option.
.. versionadded:: 3.15
- Added ``BUILD_ID`` option.
+ Added the ``BUILD_ID`` option.
diff --git a/Help/command/file.rst b/Help/command/file.rst
index 9580c9c..6837672 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -126,7 +126,7 @@ Parse a list of ASCII strings from ``<filename>`` and store it in
the ``ENCODING`` option will be defaulted to respect the Byte Order Mark.
.. versionadded:: 3.2
- Added ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings.
+ Added the ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings.
For example, the code
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index 2ef3e97..3dfd62f 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -432,7 +432,7 @@ enabled.
hard-coded guesses.
.. versionadded:: 3.16
- Added ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
+ Added the ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
various search locations.
.. |FIND_XXX| replace:: find_package
diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst
index e073a28..be9d00a 100644
--- a/Help/command/get_filename_component.rst
+++ b/Help/command/get_filename_component.rst
@@ -25,7 +25,7 @@ Sets ``<var>`` to a component of ``<FileName>``, where ``<mode>`` is one of:
PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)
.. versionadded:: 3.14
- Added ``LAST_EXT`` and ``NAME_WLE`` modes.
+ Added the ``LAST_EXT`` and ``NAME_WLE`` modes.
Paths are returned with forward slashes and have no trailing slashes.
If the optional ``CACHE`` argument is specified, the result variable is
diff --git a/Help/command/list.rst b/Help/command/list.rst
index ee3530c..7accc5a 100644
--- a/Help/command/list.rst
+++ b/Help/command/list.rst
@@ -318,10 +318,10 @@ Reverses the contents of the list in-place.
Sorts the list in-place alphabetically.
.. versionadded:: 3.13
- Added ``COMPARE``, ``CASE``, and ``ORDER`` options.
+ Added the ``COMPARE``, ``CASE``, and ``ORDER`` options.
.. versionadded:: 3.18
- Added ``COMPARE NATURAL`` option.
+ Added the ``COMPARE NATURAL`` option.
Use the ``COMPARE`` keyword to select the comparison method for sorting.
The ``<compare>`` option should be one of:
diff --git a/Help/command/message.rst b/Help/command/message.rst
index 3ea82a6..e44803e 100644
--- a/Help/command/message.rst
+++ b/Help/command/message.rst
@@ -72,7 +72,7 @@ influences the way the message is handled:
removed before releasing the project, packaging up the files, etc.
.. versionadded:: 3.15
- Added ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels.
+ Added the ``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
diff --git a/Help/command/project.rst b/Help/command/project.rst
index d3454cc..6c931b6 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -76,7 +76,7 @@ The options are:
then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`.
.. versionadded:: 3.12
- Added ``<PROJECT-NAME>_DESCRIPTION`` variable.
+ Added the ``<PROJECT-NAME>_DESCRIPTION`` variable.
``HOMEPAGE_URL <url-string>``
.. versionadded:: 3.12
@@ -120,8 +120,6 @@ options are intended for use as default values in package metadata and documenta
Code Injection
^^^^^^^^^^^^^^
-.. versionadded:: 3.15
-
If the :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` or
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE` variables are set,
the files they point to will be included as the first step of the
@@ -135,8 +133,12 @@ they point to will be included as the last step of the ``project()`` command.
If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`.
+.. versionadded:: 3.15
+ Added the ``CMAKE_PROJECT_INCLUDE`` and ``CMAKE_PROJECT_INCLUDE_BEFORE``
+ variables.
+
.. versionadded:: 3.17
- Added ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable.
+ Added the ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable.
Usage
^^^^^
diff --git a/Help/command/string.rst b/Help/command/string.rst
index 178d9d3..8ad0089 100644
--- a/Help/command/string.rst
+++ b/Help/command/string.rst
@@ -335,7 +335,7 @@ Comparison
Compare the strings and store true or false in the ``<output_variable>``.
.. versionadded:: 3.7
- Added ``LESS_EQUAL`` and ``GREATER_EQUAL`` options.
+ Added the ``LESS_EQUAL`` and ``GREATER_EQUAL`` options.
.. _`Supported Hash Algorithms`:
@@ -373,7 +373,7 @@ The supported ``<HASH>`` algorithm names are:
Keccak SHA-3.
.. versionadded:: 3.8
- Added ``SHA3`` hash algorithms.
+ Added the ``SHA3_*`` hash algorithms.
Generation
^^^^^^^^^^
diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst
index 8fbefdb..7cae613 100644
--- a/Help/cpack_gen/deb.rst
+++ b/Help/cpack_gen/deb.rst
@@ -224,7 +224,7 @@ List of CPack DEB generator specific variables:
Per-component ``CPACK_DEBIAN_<COMPONENT>_DESCRIPTION`` variables.
.. versionadded:: 3.16
- ``CPACK_PACKAGE_DESCRIPTION_FILE`` variable.
+ The ``CPACK_PACKAGE_DESCRIPTION_FILE`` variable.
.. _Debian Policy Manual: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description
@@ -303,7 +303,7 @@ List of CPack DEB generator specific variables:
* Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL`
.. versionadded:: 3.12
- ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
+ The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. note::
diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst
index 3cfa4a0..2c93569 100644
--- a/Help/cpack_gen/freebsd.rst
+++ b/Help/cpack_gen/freebsd.rst
@@ -90,7 +90,7 @@ the RPM information (e.g. package license).
for Debian packaging, so we may as well re-use it).
.. versionadded:: 3.12
- ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
+ The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. variable:: CPACK_FREEBSD_PACKAGE_LICENSE
diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst
index 0dd2816..a940a95 100644
--- a/Help/cpack_gen/ifw.rst
+++ b/Help/cpack_gen/ifw.rst
@@ -209,6 +209,8 @@ Package
.. variable:: CPACK_IFW_PACKAGE_RESOURCES
+ .. versionadded:: 3.7
+
List of additional resources ('.qrc' files) to include in the installer
binary.
@@ -279,6 +281,8 @@ These variables are cached, and may be configured if needed.
.. variable:: CPACK_IFW_ARCHIVEGEN_EXECUTABLE
+ .. versionadded:: 3.19
+
The path to ``archivegen``.
.. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE
diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst
index a8c3c5c..5260a1d 100644
--- a/Help/cpack_gen/rpm.rst
+++ b/Help/cpack_gen/rpm.rst
@@ -210,7 +210,7 @@ List of CPack RPM generator specific variables:
* Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL`
.. versionadded:: 3.12
- ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
+ The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. variable:: CPACK_RPM_PACKAGE_DESCRIPTION
CPACK_RPM_<component>_PACKAGE_DESCRIPTION
@@ -527,7 +527,7 @@ List of CPack RPM generator specific variables:
rpm -qp --scripts package.rpm
.. versionadded:: 3.18
- ``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable.
+ The ``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable.
.. variable:: CPACK_RPM_POST_INSTALL_SCRIPT_FILE
CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
@@ -551,7 +551,7 @@ List of CPack RPM generator specific variables:
rpm -qp --scripts package.rpm
.. versionadded:: 3.18
- ``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable.
+ The ``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable.
.. variable:: CPACK_RPM_USER_FILELIST
CPACK_RPM_<COMPONENT>_USER_FILELIST
diff --git a/Help/envvar/CUDAHOSTCXX.rst b/Help/envvar/CUDAHOSTCXX.rst
index 19b15e9..963f9d1 100644
--- a/Help/envvar/CUDAHOSTCXX.rst
+++ b/Help/envvar/CUDAHOSTCXX.rst
@@ -13,5 +13,8 @@ configuration run (including the first), the environment variable will be
ignored if the :variable:`CMAKE_CUDA_HOST_COMPILER` variable is defined.
This environment variable is primarily meant for use with projects that
-enable ``CUDA`` as a first-class language. The :module:`FindCUDA`
-module will also use it to initialize its ``CUDA_HOST_COMPILER`` setting.
+enable ``CUDA`` as a first-class language.
+
+.. versionadded:: 3.13
+ The :module:`FindCUDA`
+ module will use this variable to initialize its ``CUDA_HOST_COMPILER`` setting.
diff --git a/Help/generator/Green Hills MULTI.rst b/Help/generator/Green Hills MULTI.rst
index c25c5f5..5d2b1cd 100644
--- a/Help/generator/Green Hills MULTI.rst
+++ b/Help/generator/Green Hills MULTI.rst
@@ -65,7 +65,7 @@ Cache variables that are used for toolset and target system customization:
| ``GHS_OS_DIR_OPTION`` default value is ``-os_dir``.
.. versionadded:: 3.15
- ``GHS_OS_DIR_OPTION`` variable.
+ The ``GHS_OS_DIR_OPTION`` variable.
* ``GHS_BSP_NAME``