1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 20:46:37 +08:00

Help: Update Sphinx versionadded directives for 4.2 release

Run the script:

    Utilities/Sphinx/update_versions.py --since v4.1.0 --overwrite
This commit is contained in:
Brad King
2025-10-08 11:50:25 -04:00
parent 5c7e90d954
commit 5e9722866a
17 changed files with 34 additions and 0 deletions

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_VERBOSE_GENERATOR CMAKE_FASTBUILD_VERBOSE_GENERATOR
--------------------------------- ---------------------------------
.. versionadded:: 4.2
.. include:: include/ENV_VAR.rst .. include:: include/ENV_VAR.rst
The ``CMAKE_FASTBUILD_VERBOSE_GENERATOR`` environment variable specifies a custom default The ``CMAKE_FASTBUILD_VERBOSE_GENERATOR`` environment variable specifies a custom default

View File

@@ -1,6 +1,8 @@
FASTBuild FASTBuild
========= =========
.. versionadded:: 4.2
Generates a ``fbuild.bff`` file, which can be used to build the project with Generates a ``fbuild.bff`` file, which can be used to build the project with
`FASTBuild <https://www.fastbuild.org/docs/home.html>`_. `FASTBuild <https://www.fastbuild.org/docs/home.html>`_.

View File

@@ -1,6 +1,8 @@
JOB_POOL_COMPILE JOB_POOL_COMPILE
---------------- ----------------
.. versionadded:: 4.2
Ninja only: Pool used for compiling. Ninja only: Pool used for compiling.
The number of parallel compile processes could be limited by defining The number of parallel compile processes could be limited by defining

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE
----------------------------------- -----------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``AllowResponseFile`` option. Enables FASTBuild's ``AllowResponseFile`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_CACHE_PATH CMAKE_FASTBUILD_CACHE_PATH
-------------------------- --------------------------
.. versionadded:: 4.2
Specifies the directory for the FASTBuild artifact cache in the generated file. Specifies the directory for the FASTBuild artifact cache in the generated file.
If not set, FASTBuild will use the ``FASTBUILD_CACHE_PATH`` environment If not set, FASTBuild will use the ``FASTBUILD_CACHE_PATH`` environment

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV
---------------------------------- ----------------------------------
.. versionadded:: 4.2
Controls capturing of the system environment into ``fbuild.bff``. Controls capturing of the system environment into ``fbuild.bff``.
Setting it to ``OFF`` makes the invocation of all tools (compilers and other external processes) hermetic. Setting it to ``OFF`` makes the invocation of all tools (compilers and other external processes) hermetic.

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG
------------------------------------------ ------------------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``ClangGCCUpdateXLanguageArg`` option. Enables FASTBuild's ``ClangGCCUpdateXLanguageArg`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES
-------------------------------------- --------------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``ClangRewriteIncludes`` option. Enables FASTBuild's ``ClangRewriteIncludes`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_COMPILER_EXTRA_FILES CMAKE_FASTBUILD_COMPILER_EXTRA_FILES
------------------------------------- -------------------------------------
.. versionadded:: 4.2
Specifies a semicolon-separated list of additional files (usually DLLs) to Specifies a semicolon-separated list of additional files (usually DLLs) to
include in the FASTBuild ``Compiler()`` node. include in the FASTBuild ``Compiler()`` node.

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_ENV_OVERRIDES CMAKE_FASTBUILD_ENV_OVERRIDES
----------------------------- -----------------------------
.. versionadded:: 4.2
Allows overriding environment variables in the captured environment written to Allows overriding environment variables in the captured environment written to
``fbuild.bff``. ``fbuild.bff``.

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_FORCE_RESPONSE_FILE CMAKE_FASTBUILD_FORCE_RESPONSE_FILE
----------------------------------- -----------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``ForceResponseFile`` option. Enables FASTBuild's ``ForceResponseFile`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_SOURCE_MAPPING CMAKE_FASTBUILD_SOURCE_MAPPING
------------------------------ ------------------------------
.. versionadded:: 4.2
Sets FASTBuild's ``SourceMapping_Experimental`` option. Sets FASTBuild's ``SourceMapping_Experimental`` option.
Example: Example:

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT
------------------------------------------ ------------------------------------------
.. versionadded:: 4.2
By default, custom commands declaring only ``BYPRODUCTS`` will always By default, custom commands declaring only ``BYPRODUCTS`` will always
run unconditionally. run unconditionally.
You can use this variable to make FASTBuild rerun the command only when its You can use this variable to make FASTBuild rerun the command only when its

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS
--------------------------------------- ---------------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``UseDeterministicPaths_Experimental`` option. Enables FASTBuild's ``UseDeterministicPaths_Experimental`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_USE_LIGHTCACHE CMAKE_FASTBUILD_USE_LIGHTCACHE
------------------------------- -------------------------------
.. versionadded:: 4.2
Enables FASTBuilds *light caching* mode, which accelerates cache lookups by Enables FASTBuilds *light caching* mode, which accelerates cache lookups by
parsing source files directly (instead of invoking the compiler preprocessor). parsing source files directly (instead of invoking the compiler preprocessor).

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_USE_RELATIVE_PATHS CMAKE_FASTBUILD_USE_RELATIVE_PATHS
---------------------------------- ----------------------------------
.. versionadded:: 4.2
Enables FASTBuild's ``UseRelativePaths_Experimental`` option. Enables FASTBuild's ``UseRelativePaths_Experimental`` option.
See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_ See the `FASTBuild Compiler() documentation <https://www.fastbuild.org/docs/functions/compiler.html>`_

View File

@@ -1,6 +1,8 @@
CMAKE_FASTBUILD_VERBOSE_GENERATOR CMAKE_FASTBUILD_VERBOSE_GENERATOR
---------------------------------- ----------------------------------
.. versionadded:: 4.2
Enables verbose logging during FASTBuild file generation. Enables verbose logging during FASTBuild file generation.
Initialized by the :envvar:`CMAKE_FASTBUILD_VERBOSE_GENERATOR` Initialized by the :envvar:`CMAKE_FASTBUILD_VERBOSE_GENERATOR`