From 51e4d81f166a21e1c6b63d90eaf17bc73a9d7ad8 Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Thu, 23 Jan 2025 15:31:59 +0500 Subject: Help: Remove accidental blockquotes around lists Indenting a list relative to the previous paragraph creates a blockquote. Combined with the natural list indent it results in an overly large left margin. --- Help/command/add_custom_command.rst | 9 +++-- Help/command/add_custom_target.rst | 8 ++--- Help/command/cmake_path.rst | 16 ++++----- Help/command/find_package.rst | 24 ++++++------- Help/command/separate_arguments.rst | 4 +-- Help/command/set_source_files_properties.rst | 22 ++++++------ Help/cpack_gen/deb.rst | 4 +-- Help/cpack_gen/ifw.rst | 12 +++---- Help/cpack_gen/rpm.rst | 4 +-- Help/policy/CMP0112.rst | 24 ++++++------- Help/prop_test/ENVIRONMENT_MODIFICATION.rst | 40 +++++++++++----------- Help/release/3.14.rst | 36 +++++++++---------- Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt | 6 ++-- Modules/CSharpUtilities.cmake | 19 +++++----- 14 files changed, 115 insertions(+), 113 deletions(-) diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst index a88f3a7..dffefe5 100644 --- a/Help/command/add_custom_command.rst +++ b/Help/command/add_custom_command.rst @@ -141,17 +141,16 @@ The options are: built before any target using this custom command (see policy :policy:`CMP0112`). - * ``TARGET_FILE`` - * ``TARGET_LINKER_FILE`` - * ``TARGET_SONAME_FILE`` - * ``TARGET_PDB_FILE`` + * ``TARGET_FILE`` + * ``TARGET_LINKER_FILE`` + * ``TARGET_SONAME_FILE`` + * ``TARGET_PDB_FILE`` This target-level dependency does NOT add a file-level dependency that would cause the custom command to re-run whenever the executable is recompiled. List target names with the ``DEPENDS`` option to add such file-level dependencies. - ``COMMENT`` Display the given message before the commands are executed at build time. This will be ignored if ``APPEND`` is given, although a future diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst index d88e0f0..b099835 100644 --- a/Help/command/add_custom_target.rst +++ b/Help/command/add_custom_target.rst @@ -103,10 +103,10 @@ The options are: dependency will be added automatically so that the mentioned target will be built before this custom target (see policy :policy:`CMP0112`). - * ``TARGET_FILE`` - * ``TARGET_LINKER_FILE`` - * ``TARGET_SONAME_FILE`` - * ``TARGET_PDB_FILE`` + * ``TARGET_FILE`` + * ``TARGET_LINKER_FILE`` + * ``TARGET_SONAME_FILE`` + * ``TARGET_PDB_FILE`` The command and arguments are optional and if not specified an empty target will be created. diff --git a/Help/command/cmake_path.rst b/Help/command/cmake_path.rst index 39b7b99..81932b6 100644 --- a/Help/command/cmake_path.rst +++ b/Help/command/cmake_path.rst @@ -122,11 +122,11 @@ constraints): identify a file, a hard link, a symbolic link, or a directory. Two special cases are recognized: - * The item name consisting of a single dot character ``.`` is a - directory name that refers to the current directory. + * The item name consisting of a single dot character ``.`` is a + directory name that refers to the current directory. - * The item name consisting of two dot characters ``..`` is a - directory name that refers to the parent directory. + * The item name consisting of two dot characters ``..`` is a + directory name that refers to the parent directory. The ``(...)*`` pattern shown above is to indicate that there can be zero or more item names, with multiple items separated by a @@ -154,11 +154,11 @@ constraints): The following exceptions apply to the above interpretation: - * If the first character in the ``filename`` is a period, that period is - ignored (i.e. a ``filename`` like ``".profile"`` is treated as having - no extension). + * If the first character in the ``filename`` is a period, that period is + ignored (i.e. a ``filename`` like ``".profile"`` is treated as having + no extension). - * If the ``filename`` is either ``.`` or ``..``, it has no extension. + * If the ``filename`` is either ``.`` or ``..``, it has no extension. The *stem* is the part of the ``filename`` before the extension. diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 18aa19c..114de1f 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -208,18 +208,18 @@ The ``[version]`` argument requests a version with which the package found should be compatible. There are two possible forms in which it may be specified: - * A single version with the format ``major[.minor[.patch[.tweak]]]``, where - each component is a numeric value. - * A version range with the format ``versionMin...[<]versionMax`` where - ``versionMin`` and ``versionMax`` have the same format and constraints - on components being integers as the single version. By default, both end - points are included. By specifying ``<``, the upper end point will be - excluded. Version ranges are only supported with CMake 3.19 or later. - Note that it is not possible to extend the compatibility range specified - by the package's version file. For example, if the package version file - specifies compatibility within a minor version, it is not possible to - extend the compatibility to several minor versions by specifying a - version range. +* A single version with the format ``major[.minor[.patch[.tweak]]]``, where + each component is a numeric value. +* A version range with the format ``versionMin...[<]versionMax`` where + ``versionMin`` and ``versionMax`` have the same format and constraints + on components being integers as the single version. By default, both end + points are included. By specifying ``<``, the upper end point will be + excluded. Version ranges are only supported with CMake 3.19 or later. + Note that it is not possible to extend the compatibility range specified + by the package's version file. For example, if the package version file + specifies compatibility within a minor version, it is not possible to + extend the compatibility to several minor versions by specifying a + version range. The ``EXACT`` option requests that the version be matched exactly. This option is incompatible with the specification of a version range. diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst index 4f0b25e..b9148f0 100644 --- a/Help/command/separate_arguments.rst +++ b/Help/command/separate_arguments.rst @@ -45,8 +45,8 @@ be one of the following keywords: ```` will be empty. Otherwise, ```` is a list of 2 elements: - 0. Absolute path of the program - 1. Any command-line arguments present in ```` as a string + 0. Absolute path of the program + 1. Any command-line arguments present in ```` as a string For example: diff --git a/Help/command/set_source_files_properties.rst b/Help/command/set_source_files_properties.rst index d937b33..869f200 100644 --- a/Help/command/set_source_files_properties.rst +++ b/Help/command/set_source_files_properties.rst @@ -19,17 +19,17 @@ list. same directory (``CMakeLists.txt``). Visibility can be set in other directory scopes using one or both of the following options: -``DIRECTORY ...`` - The source file properties will be set in each of the ```` - directories' scopes. CMake must already know about each of these - source directories, either by having added them through a call to - :command:`add_subdirectory` or it being the top level source directory. - Relative paths are treated as relative to the current source directory. - -``TARGET_DIRECTORY ...`` - The source file properties will be set in each of the directory scopes - where any of the specified ```` were created (the ```` - must therefore already exist). + ``DIRECTORY ...`` + The source file properties will be set in each of the ```` + directories' scopes. CMake must already know about each of these + source directories, either by having added them through a call to + :command:`add_subdirectory` or it being the top level source directory. + Relative paths are treated as relative to the current source directory. + + ``TARGET_DIRECTORY ...`` + The source file properties will be set in each of the directory scopes + where any of the specified ```` were created (the ```` + must therefore already exist). Use :command:`get_source_file_property` to get property values. See also the :command:`set_property(SOURCE)` command. diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst index 31143bb..ce7a3e8 100644 --- a/Help/cpack_gen/deb.rst +++ b/Help/cpack_gen/deb.rst @@ -25,8 +25,8 @@ or a component GROUP name. Here are some CPack DEB generator wiki resources that are here for historic reasons and are no longer maintained but may still prove useful: - - https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration - - https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#deb-unix-only +- https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration +- https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#deb-unix-only List of CPack DEB generator specific variables: diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst index 488a6dd..9687281 100644 --- a/Help/cpack_gen/ifw.rst +++ b/Help/cpack_gen/ifw.rst @@ -349,12 +349,12 @@ Package Archive compression level. The allowable values are: - * 0 (*No compression*) - * 1 (*Fastest compression*) - * 3 (*Fast compression*) - * 5 (*Normal compression*) - * 7 (*Maximum compression*) - * 9 (*Ultra compression*) + * 0 (*No compression*) + * 1 (*Fastest compression*) + * 3 (*Fast compression*) + * 5 (*Normal compression*) + * 7 (*Maximum compression*) + * 9 (*Ultra compression*) If this variable is not set, QtIFW will use a default compression level, which will typically be 5 (*Normal compression*). diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst index ae6823d..599c6be 100644 --- a/Help/cpack_gen/rpm.rst +++ b/Help/cpack_gen/rpm.rst @@ -36,8 +36,8 @@ https://rpm.org/documentation. Here are some CPack RPM generator wiki resources that are here for historic reasons and are no longer maintained but may still prove useful: - - https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration - - https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#rpm-unix-only +- https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration +- https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#rpm-unix-only List of CPack RPM generator specific variables: diff --git a/Help/policy/CMP0112.rst b/Help/policy/CMP0112.rst index 2d21d96..2b21eaf 100644 --- a/Help/policy/CMP0112.rst +++ b/Help/policy/CMP0112.rst @@ -8,18 +8,18 @@ Target file component generator expressions do not add target dependencies. The following target-based generator expressions that query for directory or file name components no longer add a dependency on the evaluated target. - - ``TARGET_FILE_NAME`` - - ``TARGET_FILE_DIR`` - - ``TARGET_LINKER_FILE_BASE_NAME`` - - ``TARGET_LINKER_FILE_NAME`` - - ``TARGET_LINKER_FILE_DIR`` - - ``TARGET_SONAME_FILE_NAME`` - - ``TARGET_SONAME_FILE_DIR`` - - ``TARGET_PDB_FILE_NAME`` - - ``TARGET_PDB_FILE_DIR`` - - ``TARGET_BUNDLE_DIR`` - - ``TARGET_BUNDLE_DIR_NAME`` - - ``TARGET_BUNDLE_CONTENT_DIR`` +- ``TARGET_FILE_NAME`` +- ``TARGET_FILE_DIR`` +- ``TARGET_LINKER_FILE_BASE_NAME`` +- ``TARGET_LINKER_FILE_NAME`` +- ``TARGET_LINKER_FILE_DIR`` +- ``TARGET_SONAME_FILE_NAME`` +- ``TARGET_SONAME_FILE_DIR`` +- ``TARGET_PDB_FILE_NAME`` +- ``TARGET_PDB_FILE_DIR`` +- ``TARGET_BUNDLE_DIR`` +- ``TARGET_BUNDLE_DIR_NAME`` +- ``TARGET_BUNDLE_CONTENT_DIR`` In CMake 3.18 and lower a dependency on the evaluated target of the above diff --git a/Help/prop_test/ENVIRONMENT_MODIFICATION.rst b/Help/prop_test/ENVIRONMENT_MODIFICATION.rst index ad3e190..c6c1a82 100644 --- a/Help/prop_test/ENVIRONMENT_MODIFICATION.rst +++ b/Help/prop_test/ENVIRONMENT_MODIFICATION.rst @@ -13,26 +13,26 @@ where ``MYVAR`` is the case-sensitive name of an environment variable to be modified. Entries are considered in the order specified in the property's value. The ``OP`` may be one of: - - ``reset``: Reset to the unmodified value, ignoring all modifications to - ``MYVAR`` prior to this entry. Note that this will reset the variable to - the value set by :prop_test:`ENVIRONMENT`, if it was set, and otherwise - to its state from the rest of the CTest execution. - - ``set``: Replaces the current value of ``MYVAR`` with ``VALUE``. - - ``unset``: Unsets the current value of ``MYVAR``. - - ``string_append``: Appends singular ``VALUE`` to the current value of - ``MYVAR``. - - ``string_prepend``: Prepends singular ``VALUE`` to the current value of - ``MYVAR``. - - ``path_list_append``: Appends singular ``VALUE`` to the current value of - ``MYVAR`` using the host platform's path list separator (``;`` on Windows - and ``:`` elsewhere). - - ``path_list_prepend``: Prepends singular ``VALUE`` to the current value of - ``MYVAR`` using the host platform's path list separator (``;`` on Windows - and ``:`` elsewhere). - - ``cmake_list_append``: Appends singular ``VALUE`` to the current value of - ``MYVAR`` using ``;`` as the separator. - - ``cmake_list_prepend``: Prepends singular ``VALUE`` to the current value of - ``MYVAR`` using ``;`` as the separator. +- ``reset``: Reset to the unmodified value, ignoring all modifications to + ``MYVAR`` prior to this entry. Note that this will reset the variable to + the value set by :prop_test:`ENVIRONMENT`, if it was set, and otherwise + to its state from the rest of the CTest execution. +- ``set``: Replaces the current value of ``MYVAR`` with ``VALUE``. +- ``unset``: Unsets the current value of ``MYVAR``. +- ``string_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR``. +- ``string_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR``. +- ``path_list_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR`` using the host platform's path list separator (``;`` on Windows + and ``:`` elsewhere). +- ``path_list_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR`` using the host platform's path list separator (``;`` on Windows + and ``:`` elsewhere). +- ``cmake_list_append``: Appends singular ``VALUE`` to the current value of + ``MYVAR`` using ``;`` as the separator. +- ``cmake_list_prepend``: Prepends singular ``VALUE`` to the current value of + ``MYVAR`` using ``;`` as the separator. Unrecognized ``OP`` values will result in the test failing before it is executed. This is so that future operations may be added without changing diff --git a/Help/release/3.14.rst b/Help/release/3.14.rst index ab59ee2..f46a417 100644 --- a/Help/release/3.14.rst +++ b/Help/release/3.14.rst @@ -236,28 +236,28 @@ Modules their library names rather than header names. The old variables are provided for compatibility: - - ``X11_Xxf86misc_INCLUDE_PATH`` instead of ``X11_xf86misc_INCLUDE_PATH`` - - ``X11_Xxf86misc_LIB`` instead of ``X11_xf86misc_LIB`` - - ``X11_Xxf86misc_FOUND`` instead of ``X11_xf86misc_FOUND`` - - ``X11_Xxf86vm_INCLUDE_PATH`` instead of ``X11_xf86vmode_INCLUDE_PATH`` - - ``X11_Xxf86vm_LIB`` instead of ``X11_xf86vmode_LIB`` - - ``X11_Xxf86vm_FOUND`` instead of ``X11_xf86vmode_FOUND`` - - ``X11_xkbfile_INCLUDE_PATH`` instead of ``X11_Xkbfile_INCLUDE_PATH`` - - ``X11_xkbfile_LIB`` instead of ``X11_Xkbfile_LIB`` - - ``X11_xkbfile_FOUND`` instead of ``X11_Xkbfile_FOUND`` - - ``X11_Xtst_INCLUDE_PATH`` instead of ``X11_XTest_INCLUDE_PATH`` - - ``X11_Xtst_LIB`` instead of ``X11_XTest_LIB`` - - ``X11_Xtst_FOUND`` instead of ``X11_XTest_FOUND`` - - ``X11_Xss_INCLUDE_PATH`` instead of ``X11_Xscreensaver_INCLUDE_PATH`` - - ``X11_Xss_LIB`` instead of ``X11_Xscreensaver_LIB`` - - ``X11_Xss_FOUND`` instead of ``X11_Xscreensaver_FOUND`` + - ``X11_Xxf86misc_INCLUDE_PATH`` instead of ``X11_xf86misc_INCLUDE_PATH`` + - ``X11_Xxf86misc_LIB`` instead of ``X11_xf86misc_LIB`` + - ``X11_Xxf86misc_FOUND`` instead of ``X11_xf86misc_FOUND`` + - ``X11_Xxf86vm_INCLUDE_PATH`` instead of ``X11_xf86vmode_INCLUDE_PATH`` + - ``X11_Xxf86vm_LIB`` instead of ``X11_xf86vmode_LIB`` + - ``X11_Xxf86vm_FOUND`` instead of ``X11_xf86vmode_FOUND`` + - ``X11_xkbfile_INCLUDE_PATH`` instead of ``X11_Xkbfile_INCLUDE_PATH`` + - ``X11_xkbfile_LIB`` instead of ``X11_Xkbfile_LIB`` + - ``X11_xkbfile_FOUND`` instead of ``X11_Xkbfile_FOUND`` + - ``X11_Xtst_INCLUDE_PATH`` instead of ``X11_XTest_INCLUDE_PATH`` + - ``X11_Xtst_LIB`` instead of ``X11_XTest_LIB`` + - ``X11_Xtst_FOUND`` instead of ``X11_XTest_FOUND`` + - ``X11_Xss_INCLUDE_PATH`` instead of ``X11_Xscreensaver_INCLUDE_PATH`` + - ``X11_Xss_LIB`` instead of ``X11_Xscreensaver_LIB`` + - ``X11_Xss_FOUND`` instead of ``X11_Xscreensaver_FOUND`` The following variables are deprecated completely since they were essentially duplicates: - - ``X11_Xinput_INCLUDE_PATH`` (use ``X11_Xi_INCLUDE_PATH``) - - ``X11_Xinput_LIB`` (use ``X11_Xi_LIB``) - - ``X11_Xinput_FOUND`` (use ``X11_Xi_FOUND``) + - ``X11_Xinput_INCLUDE_PATH`` (use ``X11_Xi_INCLUDE_PATH``) + - ``X11_Xinput_LIB`` (use ``X11_Xi_LIB``) + - ``X11_Xinput_FOUND`` (use ``X11_Xi_FOUND``) * The :module:`FindX11` now provides ``X11_Xext_INCLUDE_PATH``. diff --git a/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt b/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt index 129c781..75fe0e6 100644 --- a/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt +++ b/Help/variable/LINK_LIBRARY_PREDEFINED_FEATURES.txt @@ -54,9 +54,9 @@ File paths must conform to one of the following patterns (``*`` is a wildcard, and optional parts are shown as ``[...]``): - * ``[/path/to/]FwName[.framework]`` - * ``[/path/to/]FwName.framework/FwName[suffix]`` - * ``[/path/to/]FwName.framework/Versions/*/FwName[suffix]`` + * ``[/path/to/]FwName[.framework]`` + * ``[/path/to/]FwName.framework/FwName[suffix]`` + * ``[/path/to/]FwName.framework/Versions/*/FwName[suffix]`` Note that CMake recognizes and automatically handles framework targets, even without using the :genex:`$` expression. diff --git a/Modules/CSharpUtilities.cmake b/Modules/CSharpUtilities.cmake index 1772f22..d0897d7 100644 --- a/Modules/CSharpUtilities.cmake +++ b/Modules/CSharpUtilities.cmake @@ -84,17 +84,20 @@ Main functions provided by the module are set depending on the extension of the matched file: if match is **.resx** file: - - VS_CSHARP_AutoGen "True" - - VS_CSHARP_DesignTime "True" - - VS_CSHARP_DependentUpon + + - VS_CSHARP_AutoGen "True" + - VS_CSHARP_DesignTime "True" + - VS_CSHARP_DependentUpon if match is **.cs** file: - - VS_CSHARP_DependentUpon + + - VS_CSHARP_DependentUpon if match is **.settings** file: - - VS_CSHARP_AutoGen "True" - - VS_CSHARP_DesignTimeSharedInput "True" - - VS_CSHARP_DependentUpon + + - VS_CSHARP_AutoGen "True" + - VS_CSHARP_DesignTimeSharedInput "True" + - VS_CSHARP_DependentUpon .. note:: @@ -122,7 +125,7 @@ Main functions provided by the module If a match is found, the source file properties of the ``.xaml.cs`` file are set: - - VS_CSHARP_DependentUpon + - VS_CSHARP_DependentUpon Helper functions which are used by the above ones ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit v0.12