Browse Source

Merge topic 'doc-4.0-release-cleanup'

5dff5e2f7f Help: Fix typo in 4.0 release notes for CPack archive generator
713968c280 Help: Improve wording of docs related to MSVC runtime checks
316aaa6cdd Help: Fix inaccurate wording for CMAKE_XCODE_SCHEME_... variables

Acked-by: Kitware Robot <[email protected]>
Merge-request: !10545
Craig Scott 8 months ago
parent
commit
eab202ac9d

+ 3 - 3
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
-``$<$<CONFIG:Debug>:StackFrameErrorCheck;UninitializedVariable>``, if
-supported by the compiler, or empty value otherwise.
+enables runtime checks for the ``Debug`` configuration only using the default
+value ``$<$<CONFIG:Debug>: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

+ 5 - 5
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 "$<$<CONFIG:Debug,RelWithDebInfo>: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 ``$<$<CONFIG:Debug>: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 ``$<$<CONFIG:Debug>:StackFrameErrorCheck;UninitializedVariable>``,
+if supported by the compiler, or an empty value otherwise.
 
 .. note::
 

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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``.
 

+ 1 - 1
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

+ 1 - 1
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

+ 3 - 3
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.

+ 1 - 1
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.