From e73307957eb68710c66c42babd93da9262dd00d7 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 20 Dec 2025 19:06:57 +1100 Subject: Help: Fix minor grammar problems --- Help/manual/cmake-generator-expressions.7.rst | 37 +++++++++++++++------------ Help/variable/CMAKE_FIND_REQUIRED.rst | 6 ++--- 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst index 7474197..d5dc281 100644 --- a/Help/manual/cmake-generator-expressions.7.rst +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -2241,7 +2241,7 @@ In the following, the phrase "the ``tgt`` filename" means the name of the .. versionadded:: 3.15 .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. @@ -2319,7 +2319,7 @@ In the following, the phrase "the ``tgt`` filename" means the name of the .. versionadded:: 3.27 .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. @@ -2405,14 +2405,15 @@ In the following, the phrase "the ``tgt`` filename" means the name of the .. versionadded:: 3.15 .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. Base name of file used to link the target ``tgt``, i.e. :genex:`$` without prefix and suffix, and, optionally, postfix. - For example, if target file name is ``libbase_postfix.a``, the base name is: + For example, if the target file name is ``libbase_postfix.a``, the base name + is: * ``base_postfix`` for ``$`` or ``$``. @@ -2483,14 +2484,15 @@ In the following, the phrase "the ``tgt`` filename" means the name of the .. versionadded:: 3.27 .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. Base name of library file used to link the target ``tgt``, i.e. :genex:`$` without prefix and suffix,and, optionally, postfix. - For example, if target file name is ``libbase_postfix.a``, the base name is: + For example, if the target file name is ``libbase_postfix.a``, the base name + is: * ``base_postfix`` for ``$`` or ``$``. @@ -2564,14 +2566,15 @@ In the following, the phrase "the ``tgt`` filename" means the name of the .. versionadded:: 3.27 .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. Base name of the import file used to link the target ``tgt``, i.e. :genex:`$` without prefix and suffix, and, optionally, postfix. - For example, if target file name is ``libbase_postfix.tbd``, the base name is + For example, if the target file name is ``libbase_postfix.tbd``, the base + name is * ``base_postfix`` for ``$`` or ``$``. @@ -2696,29 +2699,29 @@ In the following, the phrase "the ``tgt`` filename" means the name of the where ``tgt`` is the name of a target. .. versionadded:: 4.2 - The option ``POSTFIX``, which can be used to control the inclusion or not + The ``POSTFIX`` option can be used to control the inclusion or not of the :prop_tgt:`_POSTFIX` target property value as part of the base name. The default is ``POSTFIX:INCLUDE``. .. versionchanged:: 4.2 The postfix, as specified by :prop_tgt:`DEBUG_POSTFIX` or :prop_tgt:`_POSTFIX` target properties, is always included in the - ``PDB`` base name, except if option ``POSTFIX`` has value ``EXCLUDE``. - See the policy :policy:`CMP0202`. + ``PDB`` base name, except if the ``POSTFIX`` option has the value + ``EXCLUDE``. See the policy :policy:`CMP0202`. The base name corresponds to the target PDB file name (see ``$``) without prefix and suffix, and, optionally, - postfix. For example, if target file name is ``base_postfix.pdb``, the base - name is + postfix. For example, if the target file name is ``base_postfix.pdb``, the + base name is * ``base_postfix`` for ``$`` or ``$``. * ``base`` for ``$``. - See also the :prop_tgt:`OUTPUT_NAME`, :prop_tgt:`PDB_NAME` target properties, - and their configuration-specific variants :prop_tgt:`OUTPUT_NAME_` - and :prop_tgt:`PDB_NAME_`, and the :prop_tgt:`_POSTFIX` and - :prop_tgt:`DEBUG_POSTFIX` target properties. + See also the :prop_tgt:`OUTPUT_NAME` and :prop_tgt:`PDB_NAME` target + properties, their configuration-specific variants + :prop_tgt:`OUTPUT_NAME_` and :prop_tgt:`PDB_NAME_`, and the + :prop_tgt:`_POSTFIX` and :prop_tgt:`DEBUG_POSTFIX` target properties. Note that ``tgt`` is not added as a dependency of the target this expression is evaluated on. diff --git a/Help/variable/CMAKE_FIND_REQUIRED.rst b/Help/variable/CMAKE_FIND_REQUIRED.rst index 0518edb..cb3f4b1 100644 --- a/Help/variable/CMAKE_FIND_REQUIRED.rst +++ b/Help/variable/CMAKE_FIND_REQUIRED.rst @@ -22,6 +22,6 @@ Note that enabling this variable breaks some commonly used patterns. Multiple calls to :command:`find_package` are sometimes used to obtain a different search order to the default. -See also the :variable:`CMAKE_REQUIRE_FIND_PACKAGE_` for making -a :command:`find_package` call ``REQUIRED``, and for additional information on -how enabling these variables can break commonly used patterns. +See also the :variable:`CMAKE_REQUIRE_FIND_PACKAGE_` variable for +making a :command:`find_package` call ``REQUIRED``, and for additional +information on how enabling these variables can break commonly used patterns. -- cgit v0.12 From a7fc57ed1c93a47be207c580e5b21fb2e0477927 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 20 Dec 2025 20:47:12 +1100 Subject: Help: Restore correct sort order for property and variable manuals --- Help/manual/cmake-env-variables.7.rst | 2 +- Help/manual/cmake-properties.7.rst | 8 ++++---- Help/manual/cmake-variables.7.rst | 30 +++++++++++++++--------------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 4854717..f1b1cb1 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -62,12 +62,12 @@ Environment Variables that Control the Build /envvar/CMAKE_INSTALL_MODE /envvar/CMAKE_INSTALL_PARALLEL_LEVEL /envvar/CMAKE_INSTALL_PREFIX + /envvar/CMAKE_INTERMEDIATE_DIR_STRATEGY /envvar/CMAKE_LANG_COMPILER_LAUNCHER /envvar/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES_EXCLUDE /envvar/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES_EXCLUDE /envvar/CMAKE_LANG_LINKER_LAUNCHER /envvar/CMAKE_MSVCIDE_RUN_PATH - /envvar/CMAKE_INTERMEDIATE_DIR_STRATEGY /envvar/CMAKE_NO_VERBOSE /envvar/CMAKE_OSX_ARCHITECTURES /envvar/CMAKE_TEST_LAUNCHER diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 947b1af..5de9ccf 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -40,8 +40,8 @@ Properties of Global Scope /prop_gbl/GENERATOR_IS_MULTI_CONFIG /prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE /prop_gbl/GLOBAL_DEPENDS_NO_CYCLES - /prop_gbl/INSTALL_PARALLEL /prop_gbl/IN_TRY_COMPILE + /prop_gbl/INSTALL_PARALLEL /prop_gbl/JOB_POOLS /prop_gbl/PACKAGES_FOUND /prop_gbl/PACKAGES_NOT_FOUND @@ -333,7 +333,6 @@ Properties on Targets /prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG /prop_tgt/LIBRARY_OUTPUT_NAME /prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG - /prop_tgt/SPDX_LICENSE /prop_tgt/LINK_DEPENDS /prop_tgt/LINK_DEPENDS_NO_SHARED /prop_tgt/LINK_DIRECTORIES @@ -408,6 +407,7 @@ Properties on Targets /prop_tgt/SOURCE_DIR /prop_tgt/SOURCES /prop_tgt/SOVERSION + /prop_tgt/SPDX_LICENSE /prop_tgt/STATIC_LIBRARY_FLAGS /prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG /prop_tgt/STATIC_LIBRARY_OPTIONS @@ -505,13 +505,13 @@ Properties on Targets /prop_tgt/XCODE_SCHEME_EXECUTABLE /prop_tgt/XCODE_SCHEME_GUARD_MALLOC /prop_tgt/XCODE_SCHEME_LAUNCH_CONFIGURATION - /prop_tgt/XCODE_SCHEME_TEST_CONFIGURATION /prop_tgt/XCODE_SCHEME_LAUNCH_MODE /prop_tgt/XCODE_SCHEME_LLDB_INIT_FILE /prop_tgt/XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP /prop_tgt/XCODE_SCHEME_MALLOC_GUARD_EDGES /prop_tgt/XCODE_SCHEME_MALLOC_SCRIBBLE /prop_tgt/XCODE_SCHEME_MALLOC_STACK + /prop_tgt/XCODE_SCHEME_TEST_CONFIGURATION /prop_tgt/XCODE_SCHEME_THREAD_SANITIZER /prop_tgt/XCODE_SCHEME_THREAD_SANITIZER_STOP /prop_tgt/XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER @@ -581,6 +581,7 @@ Properties on Source Files /prop_sf/HEADER_FILE_ONLY /prop_sf/INCLUDE_DIRECTORIES /prop_sf/INSTALL_OBJECT_NAME + /prop_sf/JOB_POOL_COMPILE /prop_sf/KEEP_EXTENSION /prop_sf/LABELS /prop_sf/LANGUAGE @@ -589,7 +590,6 @@ Properties on Source Files /prop_sf/OBJECT_DEPENDS /prop_sf/OBJECT_NAME /prop_sf/OBJECT_OUTPUTS - /prop_sf/JOB_POOL_COMPILE /prop_sf/SKIP_AUTOGEN /prop_sf/SKIP_AUTOMOC /prop_sf/SKIP_AUTORCC diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 874820f..2a23383 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -56,17 +56,17 @@ Variables that Provide Information /variable/CMAKE_EXECUTABLE_SUFFIX /variable/CMAKE_EXECUTABLE_SUFFIX_LANG /variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES + /variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE /variable/CMAKE_FASTBUILD_CACHE_PATH /variable/CMAKE_FASTBUILD_CAPTURE_SYSTEM_ENV - /variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES - /variable/CMAKE_FASTBUILD_ENV_OVERRIDES - /variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT - /variable/CMAKE_FASTBUILD_ALLOW_RESPONSE_FILE /variable/CMAKE_FASTBUILD_CLANG_GCC_UPDATE_XLANG_ARG /variable/CMAKE_FASTBUILD_CLANG_REWRITE_INCLUDES + /variable/CMAKE_FASTBUILD_COMPILER_EXTRA_FILES + /variable/CMAKE_FASTBUILD_ENV_OVERRIDES /variable/CMAKE_FASTBUILD_FORCE_RESPONSE_FILE /variable/CMAKE_FASTBUILD_IDE_ARGS /variable/CMAKE_FASTBUILD_SOURCE_MAPPING + /variable/CMAKE_FASTBUILD_TRACK_BYPRODUCTS_AS_OUTPUT /variable/CMAKE_FASTBUILD_USE_DETERMINISTIC_PATHS /variable/CMAKE_FASTBUILD_USE_LIGHTCACHE /variable/CMAKE_FASTBUILD_USE_RELATIVE_PATHS @@ -128,9 +128,9 @@ Variables that Provide Information /variable/CMAKE_ROOT /variable/CMAKE_RULE_MESSAGES /variable/CMAKE_SCRIPT_MODE_FILE + /variable/CMAKE_SHARED_LIBRARY_ARCHIVE_SUFFIX /variable/CMAKE_SHARED_LIBRARY_PREFIX /variable/CMAKE_SHARED_LIBRARY_SUFFIX - /variable/CMAKE_SHARED_LIBRARY_ARCHIVE_SUFFIX /variable/CMAKE_SHARED_MODULE_PREFIX /variable/CMAKE_SHARED_MODULE_SUFFIX /variable/CMAKE_SIZEOF_VOID_P @@ -229,9 +229,9 @@ Variables that Change Behavior /variable/CMAKE_EXECUTE_PROCESS_COMMAND_ERROR_IS_FATAL /variable/CMAKE_EXPORT_BUILD_DATABASE /variable/CMAKE_EXPORT_COMPILE_COMMANDS - /variable/CMAKE_EXPORT_SARIF - /variable/CMAKE_EXPORT_PACKAGE_REGISTRY /variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY + /variable/CMAKE_EXPORT_PACKAGE_REGISTRY + /variable/CMAKE_EXPORT_SARIF /variable/CMAKE_FIND_APPBUNDLE /variable/CMAKE_FIND_FRAMEWORK /variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX @@ -266,6 +266,7 @@ Variables that Change Behavior /variable/CMAKE_INSTALL_MESSAGE /variable/CMAKE_INSTALL_PREFIX /variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT + /variable/CMAKE_INTERMEDIATE_DIR_STRATEGY /variable/CMAKE_KATE_FILES_MODE /variable/CMAKE_KATE_MAKE_ARGUMENTS /variable/CMAKE_LIBRARY_PATH @@ -278,7 +279,6 @@ Variables that Change Behavior /variable/CMAKE_MESSAGE_LOG_LEVEL /variable/CMAKE_MFC_FLAG /variable/CMAKE_MODULE_PATH - /variable/CMAKE_INTERMEDIATE_DIR_STRATEGY /variable/CMAKE_PKG_CONFIG_DISABLE_UNINSTALLED /variable/CMAKE_PKG_CONFIG_PC_LIB_DIRS /variable/CMAKE_PKG_CONFIG_PC_PATH @@ -333,13 +333,13 @@ Variables that Change Behavior /variable/CMAKE_XCODE_SCHEME_ENVIRONMENT /variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC /variable/CMAKE_XCODE_SCHEME_LAUNCH_CONFIGURATION - /variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION /variable/CMAKE_XCODE_SCHEME_LAUNCH_MODE /variable/CMAKE_XCODE_SCHEME_LLDB_INIT_FILE /variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP /variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES /variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE /variable/CMAKE_XCODE_SCHEME_MALLOC_STACK + /variable/CMAKE_XCODE_SCHEME_TEST_CONFIGURATION /variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER /variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP /variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER @@ -363,8 +363,8 @@ Variables that Describe the System /variable/CMAKE_ANDROID_NDK_VERSION /variable/CMAKE_CL_64 /variable/CMAKE_COMPILER_2005 - /variable/CMAKE_HOST_APPLE /variable/CMAKE_HOST_AIX + /variable/CMAKE_HOST_APPLE /variable/CMAKE_HOST_BSD /variable/CMAKE_HOST_EXECUTABLE_SUFFIX /variable/CMAKE_HOST_LINUX @@ -408,8 +408,8 @@ Variables that Control the Build :maxdepth: 1 /variable/CMAKE_ADSP_ROOT - /variable/CMAKE_AIX_SHARED_LIBRARY_ARCHIVE /variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS + /variable/CMAKE_AIX_SHARED_LIBRARY_ARCHIVE /variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS /variable/CMAKE_ANDROID_API /variable/CMAKE_ANDROID_API_MIN @@ -449,18 +449,18 @@ Variables that Control the Build /variable/CMAKE_AUTOMOC /variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES /variable/CMAKE_AUTOMOC_DEPEND_FILTERS + /variable/CMAKE_AUTOMOC_EXECUTABLE /variable/CMAKE_AUTOMOC_INCLUDE_DIRECTORIES /variable/CMAKE_AUTOMOC_MACRO_NAMES /variable/CMAKE_AUTOMOC_MOC_OPTIONS /variable/CMAKE_AUTOMOC_PATH_PREFIX - /variable/CMAKE_AUTOMOC_EXECUTABLE /variable/CMAKE_AUTORCC - /variable/CMAKE_AUTORCC_OPTIONS /variable/CMAKE_AUTORCC_EXECUTABLE + /variable/CMAKE_AUTORCC_OPTIONS /variable/CMAKE_AUTOUIC + /variable/CMAKE_AUTOUIC_EXECUTABLE /variable/CMAKE_AUTOUIC_OPTIONS /variable/CMAKE_AUTOUIC_SEARCH_PATHS - /variable/CMAKE_AUTOUIC_EXECUTABLE /variable/CMAKE_BUILD_RPATH /variable/CMAKE_BUILD_RPATH_USE_ORIGIN /variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR @@ -517,9 +517,9 @@ Variables that Control the Build /variable/CMAKE_LANG_COMPILER_LAUNCHER /variable/CMAKE_LANG_CPPCHECK /variable/CMAKE_LANG_CPPLINT - /variable/CMAKE_LANG_LINK_DEF_FILE_FLAG /variable/CMAKE_LANG_ICSTAT /variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE + /variable/CMAKE_LANG_LINK_DEF_FILE_FLAG /variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE /variable/CMAKE_LANG_LINK_GROUP_USING_FEATURE_SUPPORTED /variable/CMAKE_LANG_LINK_LIBRARY_FEATURE_ATTRIBUTES -- cgit v0.12