From 5e9722866a84f5ee97973f022273197d8be8ea4b Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 8 Oct 2025 11:50:25 -0400 Subject: [PATCH] Help: Update Sphinx versionadded directives for 4.2 release Run the script: Utilities/Sphinx/update_versions.py --since v4.1.0 --overwrite --- Help/envvar/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst | 2 ++ Help/generator/FASTBuild.rst | 2 ++ Help/prop_sf/JOB_POOL_COMPILE.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_CACHE_PATH.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_ENV_OVERRIDES.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_SOURCE_MAPPING.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_USE_LIGHTCACHE.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS.rst | 2 ++ Help/variable/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst | 2 ++ 17 files changed, 34 insertions(+) diff --git a/Help/envvar/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst b/Help/envvar/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst index c22e3a6280..4017e59ef0 100644 --- a/Help/envvar/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst +++ b/Help/envvar/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_VERBOSE_GENERATOR --------------------------------- +.. versionadded:: 4.2 + .. include:: include/ENV_VAR.rst The ``CMAKE_FASTBUILD_VERBOSE_GENERATOR`` environment variable specifies a custom default diff --git a/Help/generator/FASTBuild.rst b/Help/generator/FASTBuild.rst index 8d5c46e41a..4f84e8682e 100644 --- a/Help/generator/FASTBuild.rst +++ b/Help/generator/FASTBuild.rst @@ -1,6 +1,8 @@ FASTBuild ========= +.. versionadded:: 4.2 + Generates a ``fbuild.bff`` file, which can be used to build the project with `FASTBuild `_. diff --git a/Help/prop_sf/JOB_POOL_COMPILE.rst b/Help/prop_sf/JOB_POOL_COMPILE.rst index 349a0b1887..79409da91c 100644 --- a/Help/prop_sf/JOB_POOL_COMPILE.rst +++ b/Help/prop_sf/JOB_POOL_COMPILE.rst @@ -1,6 +1,8 @@ JOB_POOL_COMPILE ---------------- +.. versionadded:: 4.2 + Ninja only: Pool used for compiling. The number of parallel compile processes could be limited by defining diff --git a/Help/variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE.rst b/Help/variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE.rst index e385cefb8c..c937537c8f 100644 --- a/Help/variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE.rst +++ b/Help/variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE ----------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild's ``AllowResponseFile`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_CACHE_PATH.rst b/Help/variable/CMAKE_FASTBUILD_CACHE_PATH.rst index 486da09ef0..0bb0d94615 100644 --- a/Help/variable/CMAKE_FASTBUILD_CACHE_PATH.rst +++ b/Help/variable/CMAKE_FASTBUILD_CACHE_PATH.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_CACHE_PATH -------------------------- +.. versionadded:: 4.2 + Specifies the directory for the FASTBuild artifact cache in the generated file. If not set, FASTBuild will use the ``FASTBUILD_CACHE_PATH`` environment diff --git a/Help/variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV.rst b/Help/variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV.rst index 06438ed29c..c4159842d8 100644 --- a/Help/variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV.rst +++ b/Help/variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV ---------------------------------- +.. versionadded:: 4.2 + 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. diff --git a/Help/variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG.rst b/Help/variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG.rst index 131960a130..0552d90659 100644 --- a/Help/variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG.rst +++ b/Help/variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG ------------------------------------------ +.. versionadded:: 4.2 + Enables FASTBuild's ``ClangGCCUpdateXLanguageArg`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES.rst b/Help/variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES.rst index 1ebf13fc80..4be7b2eac2 100644 --- a/Help/variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES.rst +++ b/Help/variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES -------------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild's ``ClangRewriteIncludes`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES.rst b/Help/variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES.rst index ae069b6f7c..86c6172da1 100644 --- a/Help/variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES.rst +++ b/Help/variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_COMPILER_EXTRA_FILES ------------------------------------- +.. versionadded:: 4.2 + Specifies a semicolon-separated list of additional files (usually DLLs) to include in the FASTBuild ``Compiler()`` node. diff --git a/Help/variable/CMAKE_FASTBUILD_ENV_OVERRIDES.rst b/Help/variable/CMAKE_FASTBUILD_ENV_OVERRIDES.rst index 2543a95ea4..d4694095a7 100644 --- a/Help/variable/CMAKE_FASTBUILD_ENV_OVERRIDES.rst +++ b/Help/variable/CMAKE_FASTBUILD_ENV_OVERRIDES.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_ENV_OVERRIDES ----------------------------- +.. versionadded:: 4.2 + Allows overriding environment variables in the captured environment written to ``fbuild.bff``. diff --git a/Help/variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE.rst b/Help/variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE.rst index 8155eacc82..04bae8e0a5 100644 --- a/Help/variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE.rst +++ b/Help/variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_FORCE_RESPONSE_FILE ----------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild's ``ForceResponseFile`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_SOURCE_MAPPING.rst b/Help/variable/CMAKE_FASTBUILD_SOURCE_MAPPING.rst index 8411b1525a..69cd9f2416 100644 --- a/Help/variable/CMAKE_FASTBUILD_SOURCE_MAPPING.rst +++ b/Help/variable/CMAKE_FASTBUILD_SOURCE_MAPPING.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_SOURCE_MAPPING ------------------------------ +.. versionadded:: 4.2 + Sets FASTBuild's ``SourceMapping_Experimental`` option. Example: diff --git a/Help/variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT.rst b/Help/variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT.rst index 88303d3699..07da28d73f 100644 --- a/Help/variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT.rst +++ b/Help/variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT ------------------------------------------ +.. versionadded:: 4.2 + By default, custom commands declaring only ``BYPRODUCTS`` will always run unconditionally. You can use this variable to make FASTBuild rerun the command only when its diff --git a/Help/variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS.rst b/Help/variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS.rst index 87d0e87f6e..cf2bc1929a 100644 --- a/Help/variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS.rst +++ b/Help/variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS --------------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild's ``UseDeterministicPaths_Experimental`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_USE_LIGHTCACHE.rst b/Help/variable/CMAKE_FASTBUILD_USE_LIGHTCACHE.rst index d812942ade..e3498d9546 100644 --- a/Help/variable/CMAKE_FASTBUILD_USE_LIGHTCACHE.rst +++ b/Help/variable/CMAKE_FASTBUILD_USE_LIGHTCACHE.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_USE_LIGHTCACHE ------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild’s *light caching* mode, which accelerates cache lookups by parsing source files directly (instead of invoking the compiler preprocessor). diff --git a/Help/variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS.rst b/Help/variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS.rst index e701c5a362..6fd5571e6d 100644 --- a/Help/variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS.rst +++ b/Help/variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_USE_RELATIVE_PATHS ---------------------------------- +.. versionadded:: 4.2 + Enables FASTBuild's ``UseRelativePaths_Experimental`` option. See the `FASTBuild Compiler() documentation `_ diff --git a/Help/variable/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst b/Help/variable/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst index bf334b23bf..522ed05b40 100644 --- a/Help/variable/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst +++ b/Help/variable/CMAKE_FASTBUILD_VERBOSE_GENERATOR.rst @@ -1,6 +1,8 @@ CMAKE_FASTBUILD_VERBOSE_GENERATOR ---------------------------------- +.. versionadded:: 4.2 + Enables verbose logging during FASTBuild file generation. Initialized by the :envvar:`CMAKE_FASTBUILD_VERBOSE_GENERATOR`