Merge topic 'doc-cleanup' into release-3.30

6636b11 Help: Minor grammar and formatting cleanup c2390f7 Help: Fix nuget example with unwanted comment and bad use of rst link Acked-by: Kitware Robot <[email protected]> Merge-request: !9600
Kitware · Jun 14, 2024 · 6bf32b7 · 6bf32b7
2 parents 224e7b9 + 6636b11
commit 6bf32b7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 7 deletions.
diff --git a/Help/cpack_gen/nuget.rst b/Help/cpack_gen/nuget.rst
@@ -300,7 +300,7 @@ Example usage
   set(CPACK_GENERATOR NuGet)
   # Set up package metadata
   set(CPACK_PACKAGE_NAME SamplePackage)
-  set(CPACK_PACKAGE_VERSION "1.0.0")  # Why doesn't this pick up the version from the project?
+  set(CPACK_PACKAGE_VERSION "1.0.0")
   set(CPACK_PACKAGE_VENDOR "Example Inc")
   set(CPACK_NUGET_PACKAGE_OWNERS "Example Inc")
   set(CPACK_PACKAGE_DESCRIPTION "A .NET wrapper around the foobar library for frobbling bratchens")
@@ -319,12 +319,11 @@ Example usage
   set(CPACK_NUGET_PACKAGE_DEPENDENCIES "Baz")
   set(CPACK_NUGET_PACKAGE_DEPENDENCIES_Baz_VERSION "9.8.6")
   # NB: Since "net6.0" was listed but no dependencies have been specified, an empty group
-  # will be added to the nuspec file for this framework. This can be used to address `NU5128`_.
+  # will be added to the nuspec file for this framework. This can be used to address warning NU5128.
 
   include(CPack)
 
 
-
 .. _nuget.org: https://www.nuget.org
 .. _version specification: https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges
 .. _SPDX license identifier: https://spdx.org/licenses

diff --git a/Help/policy/CMP0164.rst b/Help/policy/CMP0164.rst
@@ -7,8 +7,8 @@ CMP0164
 the platform.
 
 In CMake 3.29 and below, on platforms that do not support shared libraries
-(:prop_gbl:`TARGET_SUPPORTS_SHARED_LIBS` is ``false``), the
-:command:`add_library` command automatically converted ``SHARED`` libraries to
+(:prop_gbl:`TARGET_SUPPORTS_SHARED_LIBS` is false), the
+:command:`add_library` command automatically converts ``SHARED`` libraries to
 ``STATIC`` libraries to help users build projects on such platforms.  However,
 the semantics of shared and static libraries are different enough that such
 automatic conversion cannot work in general.  Projects using shared libraries

diff --git a/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst b/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst
@@ -3,7 +3,7 @@ TARGET_SUPPORTS_SHARED_LIBS
 
 Does the target platform support shared libraries.
 
-TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target
+``TARGET_SUPPORTS_SHARED_LIBS`` is a boolean specifying whether the target
 platform supports shared libraries.  Basically all current general
-general purpose OS do so, the exception are usually embedded systems
+purpose OS do so, the exceptions are usually embedded systems
 with no or special OSs.