From 316aaa6cdd463a218192ed6b66e02cbf14c6a109 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 28 Mar 2025 14:23:32 +1100 Subject: Help: Fix inaccurate wording for CMAKE_XCODE_SCHEME_... variables --- Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst | 2 +- Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst | 2 +- Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst | 2 +- Help/variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE.rst | 2 +- Help/variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE.rst | 6 +++--- Help/variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION.rst | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst index ce5c4b3..b01a4d9 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION.rst @@ -3,7 +3,7 @@ CMAKE_XCODE_SCHEME_ENABLE_GPU_API_VALIDATION .. versionadded:: 3.25 -Property value for ``Metal: API Validation`` in the Options section of +Populate ``Metal: API Validation`` in the Options section of the generated Xcode scheme. This variable initializes the diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst index 4600fac..669f710 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE.rst @@ -3,7 +3,7 @@ CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE .. versionadded:: 3.23 -Property value for ``GPU Frame Capture`` in the Options section of +Populate ``GPU Frame Capture`` in the Options section of the generated Xcode scheme. Example values are ``Metal`` and ``Disabled``. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst index 073a6c9..6647bc0 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION.rst @@ -3,7 +3,7 @@ CMAKE_XCODE_SCHEME_ENABLE_GPU_SHADER_VALIDATION .. versionadded:: 3.25 -Property value for ``Metal: Shader Validation`` in the Options section of +Populate ``Metal: Shader Validation`` in the Options section of the generated Xcode scheme. This variable initializes the diff --git a/Help/variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE.rst b/Help/variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE.rst index c15b1ea..ae75678 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE.rst @@ -3,7 +3,7 @@ CMAKE_XCODE_SCHEME_LAUNCH_MODE .. versionadded:: 3.25 -Property value for ``Launch`` in the Info section of the generated Xcode +Populate ``Launch`` in the Info section of the generated Xcode scheme. This variable initializes the :prop_tgt:`XCODE_SCHEME_LAUNCH_MODE` property on diff --git a/Help/variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE.rst b/Help/variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE.rst index 7328daf..7e143c6 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE.rst @@ -3,11 +3,11 @@ CMAKE_XCODE_SCHEME_LLDB_INIT_FILE .. versionadded:: 4.0 -Property value for ``LLDB Init File`` in the Info section of the generated Xcode +Populate ``LLDB Init File`` in the Info section of the generated Xcode scheme. -This variable initializes the :prop_tgt:`XCODE_SCHEME_LLDB_INIT_FILE` property on -all targets. +This variable initializes the :prop_tgt:`XCODE_SCHEME_LLDB_INIT_FILE` property +on all targets. Please refer to the :prop_tgt:`XCODE_GENERATE_SCHEME` target property documentation to see all Xcode schema related properties. diff --git a/Help/variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION.rst b/Help/variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION.rst index 3f78fbd..3610780 100644 --- a/Help/variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION.rst +++ b/Help/variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION.rst @@ -3,7 +3,7 @@ CMAKE_XCODE_SCHEME_TEST_CONFIGURATION .. versionadded:: 4.0 -Set the build configuration to test the target. +Set the build configuration for testing targets. This variable initializes the :prop_tgt:`XCODE_SCHEME_TEST_CONFIGURATION` property on all targets. -- cgit v0.12 From 713968c280618246d5c403e6c7ad5785cf5c2092 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 28 Mar 2025 14:21:14 +1100 Subject: Help: Improve wording of docs related to MSVC runtime checks --- Help/policy/CMP0184.rst | 6 +++--- Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Help/policy/CMP0184.rst b/Help/policy/CMP0184.rst index a27b696..5020829 100644 --- a/Help/policy/CMP0184.rst +++ b/Help/policy/CMP0184.rst @@ -24,9 +24,9 @@ offer a first-class abstraction. The :variable:`CMAKE_MSVC_RUNTIME_CHECKS` variable and :prop_tgt:`MSVC_RUNTIME_CHECKS` target property may be set to select the MSVC runtime checks. If they are not set, CMake -enables runtime checks in ``Debug`` configuration using the default value -``$<$:StackFrameErrorCheck;UninitializedVariable>``, if -supported by the compiler, or empty value otherwise. +enables runtime checks for the ``Debug`` configuration only using the default +value ``$<$:StackFrameErrorCheck;UninitializedVariable>``, if +supported by the compiler, or an empty value otherwise. This policy provides compatibility with projects that have not been updated to be aware of the abstraction. The policy setting takes effect as of the diff --git a/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst b/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst index 4dbcc04..72639d5 100644 --- a/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst +++ b/Help/prop_tgt/MSVC_RUNTIME_CHECKS.rst @@ -18,14 +18,14 @@ support per-configuration specification. For example, the code: set_property(TARGET foo PROPERTY MSVC_RUNTIME_CHECKS "$<$:PossibleDataLoss;UninitializedVariable>") -enables for the target ``foo`` the possible data loss and uninitialized variables checks -for the ``Debug`` and ``RelWithDebInfo`` configurations. +enables for the target ``foo`` the possible data loss and uninitialized +variables checks for the ``Debug`` and ``RelWithDebInfo`` configurations. This property is initialized from the value of the :variable:`CMAKE_MSVC_RUNTIME_CHECKS` variable, if it is set. -If this property is not set, CMake selects a runtime checks using -the default value ``$<$:StackFrameErrorCheck;UninitializedVariable>``, if -supported by the compiler, or empty value otherwise. +If this property is not set, CMake selects runtime checks using the default +value ``$<$:StackFrameErrorCheck;UninitializedVariable>``, +if supported by the compiler, or an empty value otherwise. .. note:: -- cgit v0.12 From 5dff5e2f7f9b28d91ee940fb5adcdfd8fd02d27f Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 28 Mar 2025 14:21:51 +1100 Subject: Help: Fix typo in 4.0 release notes for CPack archive generator --- Help/release/4.0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Help/release/4.0.rst b/Help/release/4.0.rst index 95b1c0b..a7a3560 100644 --- a/Help/release/4.0.rst +++ b/Help/release/4.0.rst @@ -166,7 +166,7 @@ CTest CPack ----- -* The :cpack_gen:`CPack Archive Generator` learned to generated ``.tar`` +* The :cpack_gen:`CPack Archive Generator` learned to generate ``.tar`` packages without compression. * The :cpack_gen:`CPack Archive Generator` now honors the -- cgit v0.12