diff options
author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-10 19:37:59 (GMT) |
---|---|---|
committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-11 15:38:18 (GMT) |
commit | 5934a6275cb9906d3faea22c0e25a4de4911461a (patch) | |
tree | 887b9363b13932332ccb56a44793f836b4d7895f | |
parent | b1208722c559920d83c571c26a382d0a158d5460 (diff) | |
download | CMake-5934a6275cb9906d3faea22c0e25a4de4911461a.zip CMake-5934a6275cb9906d3faea22c0e25a4de4911461a.tar.gz CMake-5934a6275cb9906d3faea22c0e25a4de4911461a.tar.bz2 |
Help: Fix `.. versionadded` directives in environment variable docs
Many environment variables were documented late and got
assigned wrong versions by the script.
(The whole Help/envvar section was only added in 3.10).
Issue: #19715
28 files changed, 6 insertions, 50 deletions
diff --git a/Help/envvar/ASM_DIALECT.rst b/Help/envvar/ASM_DIALECT.rst index a606280..c89515e 100644 --- a/Help/envvar/ASM_DIALECT.rst +++ b/Help/envvar/ASM_DIALECT.rst @@ -1,8 +1,6 @@ ASM<DIALECT> ------------ -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Preferred executable for compiling a specific dialect of assembly language diff --git a/Help/envvar/ASM_DIALECTFLAGS.rst b/Help/envvar/ASM_DIALECTFLAGS.rst index 66a75e2..2e1c6d2 100644 --- a/Help/envvar/ASM_DIALECTFLAGS.rst +++ b/Help/envvar/ASM_DIALECTFLAGS.rst @@ -1,8 +1,6 @@ ASM<DIALECT>FLAGS ----------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Default compilation flags to be used when compiling a specific dialect of an diff --git a/Help/envvar/CC.rst b/Help/envvar/CC.rst index 4c970b4..1bb8d51 100644 --- a/Help/envvar/CC.rst +++ b/Help/envvar/CC.rst @@ -1,8 +1,6 @@ CC -- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Preferred executable for compiling ``C`` language files. Will only be used by diff --git a/Help/envvar/CFLAGS.rst b/Help/envvar/CFLAGS.rst index 31db6a6..190b4f4 100644 --- a/Help/envvar/CFLAGS.rst +++ b/Help/envvar/CFLAGS.rst @@ -1,8 +1,6 @@ CFLAGS ------ -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``C`` files. Will only be diff --git a/Help/envvar/CMAKE_CONFIG_TYPE.rst b/Help/envvar/CMAKE_CONFIG_TYPE.rst index c207a48..168593d 100644 --- a/Help/envvar/CMAKE_CONFIG_TYPE.rst +++ b/Help/envvar/CMAKE_CONFIG_TYPE.rst @@ -1,8 +1,6 @@ CMAKE_CONFIG_TYPE ----------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt The default build configuration for :ref:`Build Tool Mode` and diff --git a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst index 5babbe5..77ead4d 100644 --- a/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst +++ b/Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst @@ -1,8 +1,6 @@ CMAKE_MSVCIDE_RUN_PATH ---------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Extra PATH locations for custom commands when using diff --git a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst index 4bfa36a..ef7d547 100644 --- a/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst +++ b/Help/envvar/CMAKE_OSX_ARCHITECTURES.rst @@ -1,8 +1,6 @@ CMAKE_OSX_ARCHITECTURES ----------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Target specific architectures for macOS. diff --git a/Help/envvar/CMAKE_PREFIX_PATH.rst b/Help/envvar/CMAKE_PREFIX_PATH.rst index e5d6aa1..276fdd6 100644 --- a/Help/envvar/CMAKE_PREFIX_PATH.rst +++ b/Help/envvar/CMAKE_PREFIX_PATH.rst @@ -1,8 +1,6 @@ CMAKE_PREFIX_PATH ----------------- -.. versionadded:: 3.18 - .. include:: ENV_VAR.txt The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of diff --git a/Help/envvar/CSFLAGS.rst b/Help/envvar/CSFLAGS.rst index d875209..784328a 100644 --- a/Help/envvar/CSFLAGS.rst +++ b/Help/envvar/CSFLAGS.rst @@ -1,7 +1,7 @@ CSFLAGS ------- -.. versionadded:: 3.10 +.. versionadded:: 3.9.2 .. include:: ENV_VAR.txt diff --git a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst index b27bc09..e1991b2 100644 --- a/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst +++ b/Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst @@ -1,8 +1,6 @@ CTEST_INTERACTIVE_DEBUG_MODE ---------------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Environment variable that will exist and be set to ``1`` when a test executed diff --git a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst index 9c6bd03..d8b4262 100644 --- a/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst +++ b/Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst @@ -1,8 +1,6 @@ CTEST_OUTPUT_ON_FAILURE ----------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Boolean environment variable that controls if the output should be logged for diff --git a/Help/envvar/CTEST_PARALLEL_LEVEL.rst b/Help/envvar/CTEST_PARALLEL_LEVEL.rst index a21c783..fd4936e 100644 --- a/Help/envvar/CTEST_PARALLEL_LEVEL.rst +++ b/Help/envvar/CTEST_PARALLEL_LEVEL.rst @@ -1,8 +1,6 @@ CTEST_PARALLEL_LEVEL -------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Specify the number of tests for CTest to run in parallel. See :manual:`ctest(1)` diff --git a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst index dffd63d..79dbb79 100644 --- a/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst +++ b/Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst @@ -1,8 +1,6 @@ CTEST_USE_LAUNCHERS_DEFAULT --------------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined. diff --git a/Help/envvar/CUDACXX.rst b/Help/envvar/CUDACXX.rst index 69471b0..1722128 100644 --- a/Help/envvar/CUDACXX.rst +++ b/Help/envvar/CUDACXX.rst @@ -1,7 +1,7 @@ CUDACXX ------- -.. versionadded:: 3.10 +.. versionadded:: 3.8 .. include:: ENV_VAR.txt diff --git a/Help/envvar/CUDAFLAGS.rst b/Help/envvar/CUDAFLAGS.rst index 1f1bde5..af577a0 100644 --- a/Help/envvar/CUDAFLAGS.rst +++ b/Help/envvar/CUDAFLAGS.rst @@ -1,7 +1,7 @@ CUDAFLAGS --------- -.. versionadded:: 3.10 +.. versionadded:: 3.8 .. include:: ENV_VAR.txt diff --git a/Help/envvar/CUDAHOSTCXX.rst b/Help/envvar/CUDAHOSTCXX.rst index 81c1228..19b15e9 100644 --- a/Help/envvar/CUDAHOSTCXX.rst +++ b/Help/envvar/CUDAHOSTCXX.rst @@ -1,7 +1,7 @@ CUDAHOSTCXX ----------- -.. versionadded:: 3.10 +.. versionadded:: 3.8 .. include:: ENV_VAR.txt diff --git a/Help/envvar/CXX.rst b/Help/envvar/CXX.rst index 908a521..61ba5b8 100644 --- a/Help/envvar/CXX.rst +++ b/Help/envvar/CXX.rst @@ -1,8 +1,6 @@ CXX --- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Preferred executable for compiling ``CXX`` language files. Will only be used by diff --git a/Help/envvar/CXXFLAGS.rst b/Help/envvar/CXXFLAGS.rst index a3cef77..460a347 100644 --- a/Help/envvar/CXXFLAGS.rst +++ b/Help/envvar/CXXFLAGS.rst @@ -1,8 +1,6 @@ CXXFLAGS -------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``CXX`` (C++) files. Will diff --git a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst index 7635342..6a52d64 100644 --- a/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst +++ b/Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst @@ -1,8 +1,6 @@ DASHBOARD_TEST_FROM_CTEST ------------------------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Environment variable that will exist when a test executed by :manual:`ctest(1)` diff --git a/Help/envvar/DESTDIR.rst b/Help/envvar/DESTDIR.rst index ee290f2..d2144ae 100644 --- a/Help/envvar/DESTDIR.rst +++ b/Help/envvar/DESTDIR.rst @@ -1,8 +1,6 @@ DESTDIR ------- -.. versionadded:: 3.12 - .. include:: ENV_VAR.txt On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the diff --git a/Help/envvar/FC.rst b/Help/envvar/FC.rst index dcee02d..70e1475 100644 --- a/Help/envvar/FC.rst +++ b/Help/envvar/FC.rst @@ -1,8 +1,6 @@ FC -- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Preferred executable for compiling ``Fortran`` language files. Will only be used diff --git a/Help/envvar/FFLAGS.rst b/Help/envvar/FFLAGS.rst index 4c1f3d2..53bffb6 100644 --- a/Help/envvar/FFLAGS.rst +++ b/Help/envvar/FFLAGS.rst @@ -1,8 +1,6 @@ FFLAGS ------ -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``Fortran`` files. Will only diff --git a/Help/envvar/LDFLAGS.rst b/Help/envvar/LDFLAGS.rst index 78b34f4..816d6ef 100644 --- a/Help/envvar/LDFLAGS.rst +++ b/Help/envvar/LDFLAGS.rst @@ -1,8 +1,6 @@ LDFLAGS ------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Will only be used by CMake on the first configuration to determine the default diff --git a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst index 1558704..662bd03 100644 --- a/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst +++ b/Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst @@ -1,8 +1,6 @@ MACOSX_DEPLOYMENT_TARGET ------------------------ -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Specify the minimum version of macOS on which the target binaries are diff --git a/Help/envvar/PackageName_ROOT.rst b/Help/envvar/PackageName_ROOT.rst index fc2a1d5..0cdd384 100644 --- a/Help/envvar/PackageName_ROOT.rst +++ b/Help/envvar/PackageName_ROOT.rst @@ -1,7 +1,7 @@ <PackageName>_ROOT ------------------ -.. versionadded:: 3.12.1 +.. versionadded:: 3.12 .. include:: ENV_VAR.txt diff --git a/Help/envvar/RC.rst b/Help/envvar/RC.rst index adfaecc..8a9324d 100644 --- a/Help/envvar/RC.rst +++ b/Help/envvar/RC.rst @@ -1,8 +1,6 @@ RC -- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Preferred executable for compiling ``resource`` files. Will only be used by CMake diff --git a/Help/envvar/RCFLAGS.rst b/Help/envvar/RCFLAGS.rst index f33a9a8..bc43cb2 100644 --- a/Help/envvar/RCFLAGS.rst +++ b/Help/envvar/RCFLAGS.rst @@ -1,8 +1,6 @@ RCFLAGS ------- -.. versionadded:: 3.10 - .. include:: ENV_VAR.txt Default compilation flags to be used when compiling ``resource`` files. Will diff --git a/Help/variable/PackageName_ROOT.rst b/Help/variable/PackageName_ROOT.rst index 3f7ee4c..98ba20e 100644 --- a/Help/variable/PackageName_ROOT.rst +++ b/Help/variable/PackageName_ROOT.rst @@ -1,7 +1,7 @@ <PackageName>_ROOT ------------------ -.. versionadded:: 3.12.1 +.. versionadded:: 3.12 Calls to :command:`find_package(<PackageName>)` will search in prefixes specified by the ``<PackageName>_ROOT`` CMake variable, where |