From a19058d7d8f86c8f91e294f6fc520fe97841e721 Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Tue, 10 Nov 2020 19:53:41 +0500 Subject: Help: Replace some `versionadded` directives with `versionchanged` `.. versionchanged` directive might be more appropriate when documentation refers to previous CMake version, old behavior or a policy, and there's no new parameter or a variable involved. Issue: #19715 --- Help/command/add_custom_target.rst | 2 +- Help/command/cmake_parse_arguments.rst | 2 +- Help/command/ctest_build.rst | 2 +- Help/command/ctest_start.rst | 2 +- Help/command/export.rst | 4 ++-- Help/command/file.rst | 8 ++++---- Help/command/get_filename_component.rst | 2 +- Help/command/if.rst | 2 +- Help/command/install.rst | 2 +- Help/command/mark_as_advanced.rst | 2 +- Help/command/string.rst | 2 +- Help/command/target_sources.rst | 2 +- Help/command/try_compile.rst | 6 +++--- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst index e490b18..7c29dda 100644 --- a/Help/command/add_custom_target.rst +++ b/Help/command/add_custom_target.rst @@ -107,7 +107,7 @@ The options are: (``CMakeLists.txt`` file). They will be brought up to date when the target is built. - .. versionadded:: 3.16 + .. versionchanged:: 3.16 A target-level dependency is added if any dependency is a byproduct of a target or any of its build events in the same directory to ensure the byproducts will be available before this target is built. diff --git a/Help/command/cmake_parse_arguments.rst b/Help/command/cmake_parse_arguments.rst index 824b7dd..8dedc80 100644 --- a/Help/command/cmake_parse_arguments.rst +++ b/Help/command/cmake_parse_arguments.rst @@ -41,7 +41,7 @@ The ```` argument contains all keywords for this macro which can be followed by more than one value, like e.g. the ``TARGETS`` or ``FILES`` keywords of the :command:`install` command. -.. versionadded:: 3.5 +.. versionchanged:: 3.5 All keywords shall be unique. I.e. every keyword shall only be specified once in either ````, ```` or ````. A warning will be emitted if uniqueness is diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst index 851cd7c..4d6dc5a 100644 --- a/Help/command/ctest_build.rst +++ b/Help/command/ctest_build.rst @@ -52,7 +52,7 @@ The options are: ``PROJECT_NAME `` Ignored since CMake 3.0. - .. versionadded:: 3.14 + .. versionchanged:: 3.14 This value is no longer required. ``TARGET `` diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst index f59aad5..c0f3c6d 100644 --- a/Help/command/ctest_start.rst +++ b/Help/command/ctest_start.rst @@ -31,7 +31,7 @@ The parameters are as follows: CDash server. If no ``GROUP`` is specified, the name of the model is used by default. - .. versionadded:: 3.16 + .. versionchanged:: 3.16 This replaces the deprecated option ``TRACK``. Despite the name change its behavior is unchanged. diff --git a/Help/command/export.rst b/Help/command/export.rst index f02dd2c..e8a1fa7 100644 --- a/Help/command/export.rst +++ b/Help/command/export.rst @@ -64,11 +64,11 @@ build tree. In some cases, for example for packaging and for system wide installations, it is not desirable to write the user package registry. -.. versionadded:: 3.1 +.. versionchanged:: 3.1 If the :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable is enabled, the ``export(PACKAGE)`` command will do nothing. -.. versionadded:: 3.15 +.. versionchanged:: 3.15 By default the ``export(PACKAGE)`` command does nothing (see policy :policy:`CMP0090`) because populating the user package registry has effects outside the source and build trees. Set the diff --git a/Help/command/file.rst b/Help/command/file.rst index a673357..9580c9c 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -497,7 +497,7 @@ from the input content to produce the output content. The options are: ``INPUT `` Use the content from a given file as input. - .. versionadded:: 3.10 + .. versionchanged:: 3.10 A relative path is treated with respect to the value of :variable:`CMAKE_CURRENT_SOURCE_DIR`. See policy :policy:`CMP0070`. @@ -508,7 +508,7 @@ from the input content to produce the output content. The options are: if the generated content is identical. Otherwise, the ```` must evaluate to an unique name for each configuration. - .. versionadded:: 3.10 + .. versionchanged:: 3.10 A relative path (after evaluating generator expressions) is treated with respect to the value of :variable:`CMAKE_CURRENT_BINARY_DIR`. See policy :policy:`CMP0070`. @@ -591,7 +591,7 @@ regular expressions, but much simpler. If ``RELATIVE`` flag is specified, the results will be returned as relative paths to the given path. -.. versionadded:: 3.6 +.. versionchanged:: 3.6 The results will be ordered lexicographically. On Windows and macOS, globbing is case-insensitive even if the underlying @@ -662,7 +662,7 @@ files and directories, also non-empty directories. No error is emitted if a given file does not exist. Relative input paths are evaluated with respect to the current source directory. -.. versionadded:: 3.15 +.. versionchanged:: 3.15 Empty input paths are ignored with a warning. Previous versions of CMake interpreted empty string as a relative path with respect to the current directory and removed its contents. diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index 546e353..e073a28 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -3,7 +3,7 @@ get_filename_component Get a specific component of a full filename. -.. versionadded:: 3.19 +.. versionchanged:: 3.19 This command been superseded by :command:`cmake_path` command, except ``REALPATH`` now offered by :ref:`file(REAL_PATH) ` command and ``PROGRAM`` now available in :command:`separate_arguments(PROGRAM)` command. diff --git a/Help/command/if.rst b/Help/command/if.rst index 3b01463..72d328d 100644 --- a/Help/command/if.rst +++ b/Help/command/if.rst @@ -281,7 +281,7 @@ above-documented condition syntax accepts ````: tested to see if they are boolean constants, if so they are used as such, otherwise they are assumed to be variables and are dereferenced. -.. versionadded:: 3.1 +.. versionchanged:: 3.1 To prevent ambiguity, potential variable or keyword names can be specified in a :ref:`Quoted Argument` or a :ref:`Bracket Argument`. A quoted or bracketed variable or keyword will be interpreted as a diff --git a/Help/command/install.rst b/Help/command/install.rst index 324e0c5..bd8da39 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -22,7 +22,7 @@ This command generates installation rules for a project. Install rules specified by calls to the ``install()`` command within a source directory are executed in order during installation. -.. versionadded:: 3.14 +.. versionchanged:: 3.14 Install rules in subdirectories added by calls to the :command:`add_subdirectory` command are interleaved with those in the parent directory to run in the order declared (see diff --git a/Help/command/mark_as_advanced.rst b/Help/command/mark_as_advanced.rst index 2631f1d..201363f 100644 --- a/Help/command/mark_as_advanced.rst +++ b/Help/command/mark_as_advanced.rst @@ -23,6 +23,6 @@ new values will be marked as advanced, but if a variable already has an advanced/non-advanced state, it will not be changed. -.. versionadded:: 3.17 +.. versionchanged:: 3.17 Variables passed to this command which are not already in the cache are ignored. See policy :policy:`CMP0102`. diff --git a/Help/command/string.rst b/Help/command/string.rst index 9b459b4..178d9d3 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -281,7 +281,7 @@ Store in an ```` a substring of a given ````. If ```` is ``-1`` the remainder of the string starting at ```` will be returned. -.. versionadded:: 3.2 +.. versionchanged:: 3.2 If ```` is shorter than ```` then the end of the string is used instead. Previous versions of CMake reported an error in this case. diff --git a/Help/command/target_sources.rst b/Help/command/target_sources.rst index eb147ee..520614a 100644 --- a/Help/command/target_sources.rst +++ b/Help/command/target_sources.rst @@ -17,7 +17,7 @@ The named ```` must have been created by a command such as :command:`add_custom_target` and must not be an :ref:`ALIAS target `. -.. versionadded:: 3.13 +.. versionchanged:: 3.13 Relative source file paths are interpreted as being relative to the current source directory (i.e. :variable:`CMAKE_CURRENT_SOURCE_DIR`). See policy :policy:`CMP0076`. diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 57d3ae7..06da910 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -162,7 +162,7 @@ Other Behavior Settings If :policy:`CMP0056` is set to ``NEW``, then :variable:`CMAKE_EXE_LINKER_FLAGS` is passed in as well. -.. versionadded:: 3.14 +.. versionchanged:: 3.14 If :policy:`CMP0083` is set to ``NEW``, then in order to obtain correct behavior at link time, the ``check_pie_supported()`` command from the :module:`CheckPIESupported` module must be called before using the @@ -185,7 +185,7 @@ a build configuration. ``try_compile()`` command for the source files form, not when given a whole project. -.. versionadded:: 3.8 +.. versionchanged:: 3.8 If :policy:`CMP0067` is set to ``NEW``, or any of the ``_STANDARD``, ``_STANDARD_REQUIRED``, or ``_EXTENSIONS`` options are used, then the language standard variables are honored: @@ -209,6 +209,6 @@ a build configuration. Their values are used to set the corresponding target properties in the generated project (unless overridden by an explicit option). -.. versionadded:: 3.14 +.. versionchanged:: 3.14 For the :generator:`Green Hills MULTI` generator the GHS toolset and target system customization cache variables are also propagated into the test project. -- cgit v0.12