From 914d580a4f2790b5ea88d38beca93992238e9204 Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 31 Jan 2025 12:23:14 -0500 Subject: Utilities/Sphinx: Ignore warning in generated texinfo documentation --- Utilities/Sphinx/CTestCustom.cmake.in | 1 + 1 file changed, 1 insertion(+) diff --git a/Utilities/Sphinx/CTestCustom.cmake.in b/Utilities/Sphinx/CTestCustom.cmake.in index ee13aa1..8206b36 100644 --- a/Utilities/Sphinx/CTestCustom.cmake.in +++ b/Utilities/Sphinx/CTestCustom.cmake.in @@ -1,4 +1,5 @@ list(APPEND CTEST_CUSTOM_WARNING_EXCEPTION "cmake.texi:[0-9]+: warning: .definfoenclose is obsolete" + "cmake.texi:[0-9]+: warning: @itemize has text but no @item" "cmake.texi:[0-9]+: warning: @ref should not appear on @item line" ) -- cgit v0.12 From 718043b540daf4696bdfa62c3170020b837b937d Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Thu, 23 Jan 2025 15:31:58 +0500 Subject: Help: Convert some literal blocks into tables and lists Also, ensure that header-less tables have a top border in cmake.css. --- Help/command/ctest_submit.rst | 29 ++-- Help/command/define_property.rst | 16 +- Help/command/get_filename_component.rst | 22 ++- Help/command/include_regular_expression.rst | 8 +- Help/command/load_command.rst | 6 +- Help/command/string.rst | 6 +- Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt | 16 +- Help/policy/CMP0002.rst | 10 +- Help/prop_cache/TYPE.rst | 19 ++- Help/variable/CMAKE_CFG_INTDIR.rst | 17 ++- Help/variable/MSVC_TOOLSET_VERSION.rst | 27 ++-- Help/variable/MSVC_VERSION.rst | 33 ++-- Modules/ExternalData.cmake | 49 +++--- Modules/FindDoxygen.cmake | 193 ++++++++++++------------ Utilities/Sphinx/static/cmake.css | 5 + 15 files changed, 235 insertions(+), 221 deletions(-) diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst index 2b78dd9..56a47e8 100644 --- a/Help/command/ctest_submit.rst +++ b/Help/command/ctest_submit.rst @@ -24,21 +24,20 @@ The options are: ``PARTS ...`` Specify a subset of parts to submit. Valid part names are: - .. parsed-literal:: - - Start = nothing - Update = ctest_update results, in Update.xml - Configure = ctest_configure results, in Configure.xml - Build = ctest_build results, in Build.xml - Test = ctest_test results, in Test.xml - Coverage = ctest_coverage results, in Coverage.xml - MemCheck = ctest_memcheck results, in DynamicAnalysis.xml and - DynamicAnalysis-Test.xml - Notes = Files listed by :variable:`CTEST_NOTES_FILES`, in Notes.xml - ExtraFiles = Files listed by :variable:`CTEST_EXTRA_SUBMIT_FILES` - Upload = Files prepared for upload by ctest_upload(), in Upload.xml - Submit = nothing - Done = Build is complete, in Done.xml + * ``Start`` - nothing. + * ``Update`` - :command:`ctest_update` results, in ``Update.xml``. + * ``Configure`` - :command:`ctest_configure` results, in ``Configure.xml``. + * ``Build`` - :command:`ctest_build` results, in ``Build.xml``. + * ``Test`` - :command:`ctest_test` results, in ``Test.xml``. + * ``Coverage`` - :command:`ctest_coverage` results, in ``Coverage.xml``. + * ``MemCheck`` - :command:`ctest_memcheck` results, in + ``DynamicAnalysis.xml`` and ``DynamicAnalysis-Test.xml``. + * ``Notes`` - Files listed by :variable:`CTEST_NOTES_FILES`, in ``Notes.xml``. + * ``ExtraFiles`` - Files listed by :variable:`CTEST_EXTRA_SUBMIT_FILES`. + * ``Upload`` - Files prepared for upload by :command:`ctest_upload`, in + ``Upload.xml``. + * ``Submit`` - nothing. + * ``Done`` - Build is complete, in ``Done.xml``. ``FILES ...`` Specify an explicit list of specific files to be submitted. diff --git a/Help/command/define_property.rst b/Help/command/define_property.rst index 06f2823..3dccca9 100644 --- a/Help/command/define_property.rst +++ b/Help/command/define_property.rst @@ -21,15 +21,13 @@ primary use case. The first argument determines the kind of scope in which the property should be used. It must be one of the following: -:: - - GLOBAL = associated with the global namespace - DIRECTORY = associated with one directory - TARGET = associated with one target - SOURCE = associated with one source file - TEST = associated with a test named with add_test - VARIABLE = documents a CMake language variable - CACHED_VARIABLE = documents a CMake cache variable +* ``GLOBAL`` - associated with the global namespace. +* ``DIRECTORY`` - associated with one directory. +* ``TARGET`` - associated with one target. +* ``SOURCE`` - associated with one source file. +* ``TEST`` - associated with a test named with :command:`add_test`. +* ``VARIABLE`` - documents a CMake language variable. +* ``CACHED_VARIABLE`` - documents a CMake cache variable. Note that unlike :command:`set_property` and :command:`get_property` no actual scope needs to be given; only the kind of scope is important. diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index 7d74a33..87ed6bc 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -20,15 +20,13 @@ Get a specific component of a full filename. Sets ```` to a component of ````, where ```` is one of: -:: - - DIRECTORY = Directory without file name - NAME = File name without directory - EXT = File name longest extension (.b.c from d/a.b.c) - NAME_WE = File name with neither the directory nor the longest extension - LAST_EXT = File name last extension (.c from d/a.b.c) - NAME_WLE = File name with neither the directory nor the last extension - PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) +* ``DIRECTORY`` - directory without file name. +* ``NAME`` - file name without directory. +* ``EXT`` - file name longest extension (``.b.c`` from ``d/a.b.c``). +* ``NAME_WE`` - file name with neither the directory nor the longest extension. +* ``LAST_EXT`` - file name last extension (``.c`` from ``d/a.b.c``). +* ``NAME_WLE`` - file name with neither the directory nor the last extension. +* ``PATH`` - legacy alias for ``DIRECTORY`` (use for CMake <= 2.8.11). .. versionadded:: 3.14 Added the ``LAST_EXT`` and ``NAME_WLE`` modes. @@ -46,10 +44,8 @@ added to the cache. Sets ```` to the absolute path of ````, where ```` is one of: -:: - - ABSOLUTE = Full path to file - REALPATH = Full path to existing file with symlinks resolved +* ``ABSOLUTE`` - full path to file. +* ``REALPATH`` - full path to existing file with symlinks resolved. If the provided ```` is a relative path, it is evaluated relative to the given base directory ````. If no base directory is diff --git a/Help/command/include_regular_expression.rst b/Help/command/include_regular_expression.rst index dde8378..99fd171 100644 --- a/Help/command/include_regular_expression.rst +++ b/Help/command/include_regular_expression.rst @@ -10,9 +10,7 @@ Set the regular expression used for dependency checking. Sets the regular expressions used in dependency checking. Only files matching ``regex_match`` will be traced as dependencies. Only files matching ``regex_complain`` will generate warnings if they cannot be found -(standard header paths are not searched). The defaults are: +(standard header paths are not searched). -:: - - regex_match = "^.*$" (match everything) - regex_complain = "^$" (match empty string only) +The default for ``regex_match`` is ``"^.*$"`` (match everything). +The default for ``regex_complain`` is ``"^$"`` (match empty string only). diff --git a/Help/command/load_command.rst b/Help/command/load_command.rst index 4b3888f..16516b4 100644 --- a/Help/command/load_command.rst +++ b/Help/command/load_command.rst @@ -14,10 +14,6 @@ cmCOMMAND_NAME. If found, it is loaded as a module and the command is added to the set of available CMake commands. Usually, :command:`try_compile` is used before this command to compile the module. If the command is successfully loaded a variable named - -.. code-block:: cmake - - CMAKE_LOADED_COMMAND_ - +``CMAKE_LOADED_COMMAND_`` will be set to the full path of the module that was loaded. Otherwise the variable will not be set. diff --git a/Help/command/string.rst b/Help/command/string.rst index a2e1e28..e9de32e 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -478,10 +478,8 @@ Generation If no explicit ```` is given, it will default to: - :: - - %Y-%m-%dT%H:%M:%S for local time. - %Y-%m-%dT%H:%M:%SZ for UTC. + * ``%Y-%m-%dT%H:%M:%S`` for local time. + * ``%Y-%m-%dT%H:%M:%SZ`` for UTC. .. versionadded:: 3.8 If the ``SOURCE_DATE_EPOCH`` environment variable is set, diff --git a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt index 6797d0e..f0ebc8d 100644 --- a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt +++ b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt @@ -5,14 +5,16 @@ to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value. Your work-around may break in a future version of CMake that has improved escape support. Instead consider defining the macro in a (configured) header file. Then -report the limitation. Known limitations include:: +report the limitation. Known limitations include: - # - broken almost everywhere - ; - broken in VS IDE 7.0 and Borland Makefiles - , - broken in VS IDE - % - broken in some cases in NMake - & | - broken in some cases on MinGW - ^ < > \" - broken in most Make tools on Windows + ============= ======================== + ``#`` Broken almost everywhere. + ``;`` Broken in VS IDE 7.0 and Borland Makefiles. + ``,`` Broken in VS IDE. + ``%`` Broken in some cases in NMake. + ``& |`` Broken in some cases on MinGW. + ``^ < > \ "`` Broken in most Make tools on Windows. + ============= ======================== CMake does not reject these values outright because they do work in some cases. Use with caution. diff --git a/Help/policy/CMP0002.rst b/Help/policy/CMP0002.rst index ae17c2d..02fbf57 100644 --- a/Help/policy/CMP0002.rst +++ b/Help/policy/CMP0002.rst @@ -10,12 +10,10 @@ Targets names created with :command:`add_executable`, :command:`add_library`, or :command:`add_custom_target` are logical build target names. Logical target names must be globally unique because: -:: - - - Unique names may be referenced unambiguously both in CMake - code and on make tool command lines. - - Logical names are used by Xcode and VS IDE generators - to produce meaningful project names for the targets. +* Unique names may be referenced unambiguously both in CMake + code and on make tool command lines. +* Logical names are used by Xcode and VS IDE generators + to produce meaningful project names for the targets. The logical name of executable and library targets does not have to correspond to the physical file names built. Consider using the diff --git a/Help/prop_cache/TYPE.rst b/Help/prop_cache/TYPE.rst index 7ca859f..2a7dc31 100644 --- a/Help/prop_cache/TYPE.rst +++ b/Help/prop_cache/TYPE.rst @@ -7,15 +7,18 @@ Cache entry values are always strings, but CMake GUIs present widgets to help users set values. The GUIs use this property as a hint to determine the widget type. Valid ``TYPE`` values are: -:: +.. table:: + :align: left - BOOL = Boolean ON/OFF value. - PATH = Path to a directory. - FILEPATH = Path to a file. - STRING = Generic string value. - INTERNAL = Do not present in GUI at all. - STATIC = Value managed by CMake, do not change. - UNINITIALIZED = Type not yet specified. + ================= ======================================== + ``BOOL`` Boolean ON/OFF value. + ``PATH`` Path to a directory. + ``FILEPATH`` Path to a file. + ``STRING`` Generic string value. + ``INTERNAL`` Do not present in GUI at all. + ``STATIC`` Value managed by CMake, do not change. + ``UNINITIALIZED`` Type not yet specified. + ================= ======================================== Generally the ``TYPE`` of a cache entry should be set by the command which creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.). diff --git a/Help/variable/CMAKE_CFG_INTDIR.rst b/Help/variable/CMAKE_CFG_INTDIR.rst index 3a9ddaf..b9d2919 100644 --- a/Help/variable/CMAKE_CFG_INTDIR.rst +++ b/Help/variable/CMAKE_CFG_INTDIR.rst @@ -16,13 +16,16 @@ of the per-configuration output subdirectory. On :ref:`Makefile Generators` this evaluates to ``.`` because there is only one configuration in a build tree. Example values: -:: - - $(Configuration) = Visual Studio - $(CONFIGURATION) = Xcode - . = Make-based tools - . = Ninja - ${CONFIGURATION} = Ninja Multi-Config +.. table:: + :align: left + + ========================= ============================== + ``$(Configuration)`` Visual Studio + ``$(CONFIGURATION)`` Xcode + ``.`` Make-based tools + ``.`` Ninja + ``${CONFIGURATION}`` Ninja Multi-Config + ========================= ============================== Since these values are evaluated by the native build system, this variable is suitable only for use in command lines that will be diff --git a/Help/variable/MSVC_TOOLSET_VERSION.rst b/Help/variable/MSVC_TOOLSET_VERSION.rst index 59479af..84a6f33 100644 --- a/Help/variable/MSVC_TOOLSET_VERSION.rst +++ b/Help/variable/MSVC_TOOLSET_VERSION.rst @@ -7,17 +7,24 @@ The toolset version of Microsoft Visual C/C++ being used if any. If MSVC-like is being used, this variable is set based on the version of the compiler as given by the :variable:`MSVC_VERSION` variable. -Known toolset version numbers are:: +Known toolset version numbers are: - 80 = VS 2005 (8.0) - 90 = VS 2008 (9.0) - 100 = VS 2010 (10.0) - 110 = VS 2012 (11.0) - 120 = VS 2013 (12.0) - 140 = VS 2015 (14.0) - 141 = VS 2017 (15.0) - 142 = VS 2019 (16.0) - 143 = VS 2022 (17.0) +.. table:: + :align: left + + ===== ============== + Value Version + ===== ============== + 80 VS 2005 (8.0) + 90 VS 2008 (9.0) + 100 VS 2010 (10.0) + 110 VS 2012 (11.0) + 120 VS 2013 (12.0) + 140 VS 2015 (14.0) + 141 VS 2017 (15.0) + 142 VS 2019 (16.0) + 143 VS 2022 (17.0) + ===== ============== Compiler versions newer than those known to CMake will be reported as the latest known toolset version. diff --git a/Help/variable/MSVC_VERSION.rst b/Help/variable/MSVC_VERSION.rst index 400217b..4d87a03 100644 --- a/Help/variable/MSVC_VERSION.rst +++ b/Help/variable/MSVC_VERSION.rst @@ -6,20 +6,27 @@ If a compiler simulating Visual C++ is being used, this variable is set to the toolset version simulated as given by the ``_MSC_VER`` preprocessor definition. -Known version numbers are:: +Known version numbers are: - 1200 = VS 6.0 - 1300 = VS 7.0 - 1310 = VS 7.1 - 1400 = VS 8.0 (v80 toolset) - 1500 = VS 9.0 (v90 toolset) - 1600 = VS 10.0 (v100 toolset) - 1700 = VS 11.0 (v110 toolset) - 1800 = VS 12.0 (v120 toolset) - 1900 = VS 14.0 (v140 toolset) - 1910-1919 = VS 15.0 (v141 toolset) - 1920-1929 = VS 16.0 (v142 toolset) - 1930-1949 = VS 17.0 (v143 toolset) +.. table:: + :align: left + + ========= ============== + Value Version + ========= ============== + 1200 VS 6.0 + 1300 VS 7.0 + 1310 VS 7.1 + 1400 VS 8.0 (v80 toolset) + 1500 VS 9.0 (v90 toolset) + 1600 VS 10.0 (v100 toolset) + 1700 VS 11.0 (v110 toolset) + 1800 VS 12.0 (v120 toolset) + 1900 VS 14.0 (v140 toolset) + 1910-1919 VS 15.0 (v141 toolset) + 1920-1929 VS 16.0 (v142 toolset) + 1930-1949 VS 17.0 (v143 toolset) + ========= ============== See also the :variable:`CMAKE__COMPILER_VERSION` and :variable:`MSVC_TOOLSET_VERSION` variable. diff --git a/Modules/ExternalData.cmake b/Modules/ExternalData.cmake index 5fd4c68..8c75355 100644 --- a/Modules/ExternalData.cmake +++ b/Modules/ExternalData.cmake @@ -244,21 +244,22 @@ members of a series are fetched, only the file originally named by the recognizes file series names ending with ``#.ext``, ``_#.ext``, ``.#.ext``, or ``-#.ext`` where ``#`` is a sequence of decimal digits and ``.ext`` is any single extension. Configure it with a regex that parses ```` -and ```` parts from the end of ````:: +and ```` parts from the end of ````: - ExternalData_SERIES_PARSE = regex of the form ()()$ + ``ExternalData_SERIES_PARSE`` - regex of the form ``()()$``. -For more complicated cases set:: +For more complicated cases set: - ExternalData_SERIES_PARSE = regex with at least two () groups - ExternalData_SERIES_PARSE_PREFIX = regex group number, if any - ExternalData_SERIES_PARSE_NUMBER = regex group number - ExternalData_SERIES_PARSE_SUFFIX = regex group number +* ``ExternalData_SERIES_PARSE`` - regex with at least two ``()`` groups. +* ``ExternalData_SERIES_PARSE_PREFIX`` - regex group number of the ````, if any. +* ``ExternalData_SERIES_PARSE_NUMBER`` - regex group number of the ````. +* ``ExternalData_SERIES_PARSE_SUFFIX`` - regex group number of the ````. Configure series number matching with a regex that matches the -```` part of series members named ````:: +```` part of series members named ````: - ExternalData_SERIES_MATCH = regex matching in all series members + ``ExternalData_SERIES_MATCH`` - regex matching ```` in all series + members Note that the ```` of a series does not include a hash-algorithm extension. @@ -298,20 +299,22 @@ source directory. Hash Algorithms ^^^^^^^^^^^^^^^ -The following hash algorithms are supported:: - - %(algo) Description - ------- ----- ----------- - MD5 .md5 Message-Digest Algorithm 5, RFC 1321 - SHA1 .sha1 US Secure Hash Algorithm 1, RFC 3174 - SHA224 .sha224 US Secure Hash Algorithms, RFC 4634 - SHA256 .sha256 US Secure Hash Algorithms, RFC 4634 - SHA384 .sha384 US Secure Hash Algorithms, RFC 4634 - SHA512 .sha512 US Secure Hash Algorithms, RFC 4634 - SHA3_224 .sha3-224 Keccak SHA-3 - SHA3_256 .sha3-256 Keccak SHA-3 - SHA3_384 .sha3-384 Keccak SHA-3 - SHA3_512 .sha3-512 Keccak SHA-3 +The following hash algorithms are supported: + + ============ ============= ============ + %(algo) Description + ============ ============= ============ + ``MD5`` ``.md5`` Message-Digest Algorithm 5, RFC 1321 + ``SHA1`` ``.sha1`` US Secure Hash Algorithm 1, RFC 3174 + ``SHA224`` ``.sha224`` US Secure Hash Algorithms, RFC 4634 + ``SHA256`` ``.sha256`` US Secure Hash Algorithms, RFC 4634 + ``SHA384`` ``.sha384`` US Secure Hash Algorithms, RFC 4634 + ``SHA512`` ``.sha512`` US Secure Hash Algorithms, RFC 4634 + ``SHA3_224`` ``.sha3-224`` Keccak SHA-3 + ``SHA3_256`` ``.sha3-256`` Keccak SHA-3 + ``SHA3_384`` ``.sha3-384`` Keccak SHA-3 + ``SHA3_512`` ``.sha3-512`` Keccak SHA-3 + ============ ============= ============ .. versionadded:: 3.8 Added the ``SHA3_*`` hash algorithms. diff --git a/Modules/FindDoxygen.cmake b/Modules/FindDoxygen.cmake index 0920c83..51503b6 100644 --- a/Modules/FindDoxygen.cmake +++ b/Modules/FindDoxygen.cmake @@ -39,21 +39,22 @@ The following variables are defined by this module: The version reported by ``doxygen --version``. -.. versionadded:: 3.9 - The module defines ``IMPORTED`` targets for Doxygen and each component found. - These can be used as part of custom commands, etc. and should be preferred over - old-style (and now deprecated) variables like ``DOXYGEN_EXECUTABLE``. The - following import targets are defined if their corresponding executable could be - found (the component import targets will only be defined if that component was - requested): +Imported Targets +^^^^^^^^^^^^^^^^ -:: +.. versionadded:: 3.9 - Doxygen::doxygen - Doxygen::dot - Doxygen::mscgen - Doxygen::dia +The module defines ``IMPORTED`` targets for Doxygen and each component found. +These can be used as part of custom commands, etc. and should be preferred over +old-style (and now deprecated) variables like ``DOXYGEN_EXECUTABLE``. The +following import targets are defined if their corresponding executable could be +found (the component import targets will only be defined if that component was +requested): +* ``Doxygen::doxygen`` +* ``Doxygen::dot`` +* ``Doxygen::mscgen`` +* ``Doxygen::dia`` Functions ^^^^^^^^^ @@ -231,94 +232,94 @@ options and will convert their associated CMake variable's contents into the required form if set. CMake variables are named ``DOXYGEN_`` for the Doxygen settings specified here. -:: - - ABBREVIATE_BRIEF - ALIASES - CITE_BIB_FILES - DIAFILE_DIRS - DOTFILE_DIRS - DOT_FONTPATH - ENABLED_SECTIONS - EXAMPLE_PATH - EXAMPLE_PATTERNS - EXCLUDE - EXCLUDE_PATTERNS - EXCLUDE_SYMBOLS - EXPAND_AS_DEFINED - EXTENSION_MAPPING - EXTRA_PACKAGES - EXTRA_SEARCH_MAPPINGS - FILE_PATTERNS - FILTER_PATTERNS - FILTER_SOURCE_PATTERNS - HTML_EXTRA_FILES - HTML_EXTRA_STYLESHEET - IGNORE_PREFIX - IMAGE_PATH - INCLUDE_FILE_PATTERNS - INCLUDE_PATH - INPUT - LATEX_EXTRA_FILES - LATEX_EXTRA_STYLESHEET - MATHJAX_EXTENSIONS - MSCFILE_DIRS - PLANTUML_INCLUDE_PATH - PREDEFINED - QHP_CUST_FILTER_ATTRS - QHP_SECT_FILTER_ATTRS - STRIP_FROM_INC_PATH - STRIP_FROM_PATH - TAGFILES - TCL_SUBST +.. hlist:: + + - ``ABBREVIATE_BRIEF`` + - ``ALIASES`` + - ``CITE_BIB_FILES`` + - ``DIAFILE_DIRS`` + - ``DOTFILE_DIRS`` + - ``DOT_FONTPATH`` + - ``ENABLED_SECTIONS`` + - ``EXAMPLE_PATH`` + - ``EXAMPLE_PATTERNS`` + - ``EXCLUDE`` + - ``EXCLUDE_PATTERNS`` + - ``EXCLUDE_SYMBOLS`` + - ``EXPAND_AS_DEFINED`` + - ``EXTENSION_MAPPING`` + - ``EXTRA_PACKAGES`` + - ``EXTRA_SEARCH_MAPPINGS`` + - ``FILE_PATTERNS`` + - ``FILTER_PATTERNS`` + - ``FILTER_SOURCE_PATTERNS`` + - ``HTML_EXTRA_FILES`` + - ``HTML_EXTRA_STYLESHEET`` + - ``IGNORE_PREFIX`` + - ``IMAGE_PATH`` + - ``INCLUDE_FILE_PATTERNS`` + - ``INCLUDE_PATH`` + - ``INPUT`` + - ``LATEX_EXTRA_FILES`` + - ``LATEX_EXTRA_STYLESHEET`` + - ``MATHJAX_EXTENSIONS`` + - ``MSCFILE_DIRS`` + - ``PLANTUML_INCLUDE_PATH`` + - ``PREDEFINED`` + - ``QHP_CUST_FILTER_ATTRS`` + - ``QHP_SECT_FILTER_ATTRS`` + - ``STRIP_FROM_INC_PATH`` + - ``STRIP_FROM_PATH`` + - ``TAGFILES`` + - ``TCL_SUBST`` The following single value Doxygen options will be quoted automatically if they contain at least one space: -:: - - CHM_FILE - DIA_PATH - DOCBOOK_OUTPUT - DOCSET_FEEDNAME - DOCSET_PUBLISHER_NAME - DOT_FONTNAME - DOT_PATH - EXTERNAL_SEARCH_ID - FILE_VERSION_FILTER - GENERATE_TAGFILE - HHC_LOCATION - HTML_FOOTER - HTML_HEADER - HTML_OUTPUT - HTML_STYLESHEET - INPUT_FILTER - LATEX_FOOTER - LATEX_HEADER - LATEX_OUTPUT - LAYOUT_FILE - MAN_OUTPUT - MAN_SUBDIR - MATHJAX_CODEFILE - MSCGEN_PATH - OUTPUT_DIRECTORY - PERL_PATH - PLANTUML_JAR_PATH - PROJECT_BRIEF - PROJECT_LOGO - PROJECT_NAME - QCH_FILE - QHG_LOCATION - QHP_CUST_FILTER_NAME - QHP_VIRTUAL_FOLDER - RTF_EXTENSIONS_FILE - RTF_OUTPUT - RTF_STYLESHEET_FILE - SEARCHDATA_FILE - USE_MDFILE_AS_MAINPAGE - WARN_FORMAT - WARN_LOGFILE - XML_OUTPUT +.. hlist:: + + - ``CHM_FILE`` + - ``DIA_PATH`` + - ``DOCBOOK_OUTPUT`` + - ``DOCSET_FEEDNAME`` + - ``DOCSET_PUBLISHER_NAME`` + - ``DOT_FONTNAME`` + - ``DOT_PATH`` + - ``EXTERNAL_SEARCH_ID`` + - ``FILE_VERSION_FILTER`` + - ``GENERATE_TAGFILE`` + - ``HHC_LOCATION`` + - ``HTML_FOOTER`` + - ``HTML_HEADER`` + - ``HTML_OUTPUT`` + - ``HTML_STYLESHEET`` + - ``INPUT_FILTER`` + - ``LATEX_FOOTER`` + - ``LATEX_HEADER`` + - ``LATEX_OUTPUT`` + - ``LAYOUT_FILE`` + - ``MAN_OUTPUT`` + - ``MAN_SUBDIR`` + - ``MATHJAX_CODEFILE`` + - ``MSCGEN_PATH`` + - ``OUTPUT_DIRECTORY`` + - ``PERL_PATH`` + - ``PLANTUML_JAR_PATH`` + - ``PROJECT_BRIEF`` + - ``PROJECT_LOGO`` + - ``PROJECT_NAME`` + - ``QCH_FILE`` + - ``QHG_LOCATION`` + - ``QHP_CUST_FILTER_NAME`` + - ``QHP_VIRTUAL_FOLDER`` + - ``RTF_EXTENSIONS_FILE`` + - ``RTF_OUTPUT`` + - ``RTF_STYLESHEET_FILE`` + - ``SEARCHDATA_FILE`` + - ``USE_MDFILE_AS_MAINPAGE`` + - ``WARN_FORMAT`` + - ``WARN_LOGFILE`` + - ``XML_OUTPUT`` .. versionadded:: 3.11 There are situations where it may be undesirable for a particular config option diff --git a/Utilities/Sphinx/static/cmake.css b/Utilities/Sphinx/static/cmake.css index 9e7dfa3..909b58a 100644 --- a/Utilities/Sphinx/static/cmake.css +++ b/Utilities/Sphinx/static/cmake.css @@ -86,3 +86,8 @@ code.xref.cmake-guide { code.xref.cmake-guide span.pre { white-space: inherit; } + +/* Ensure top border for header-less tables. */ +table.docutils td { + border-top: 1px solid #aaa; +} -- cgit v0.12 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 From 9c963de99854587248d340c38f15eb44c00aeacc Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Fri, 31 Jan 2025 00:10:17 +0500 Subject: Help: Remove stray spaces and one colon --- Help/command/FIND_XXX.txt | 4 ++-- Help/command/add_custom_target.rst | 2 +- Help/command/block.rst | 2 +- Help/command/configure_file.rst | 2 +- Help/command/file.rst | 4 ++-- Help/command/find_package.rst | 4 ++-- Help/command/fltk_wrap_ui.rst | 2 +- Help/command/list.rst | 2 +- Help/command/subdirs.rst | 2 +- Help/cpack_gen/rpm.rst | 2 +- Help/guide/importing-exporting/index.rst | 2 +- Help/guide/tutorial/Complete/CMakeLists.txt | 2 +- Help/manual/cmake.1.rst | 2 +- Help/prop_cache/TYPE.rst | 2 +- Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst | 2 +- Modules/CMakeDetermineVSServicePack.cmake | 4 ++-- Modules/WriteBasicConfigVersionFile.cmake | 2 +- 17 files changed, 21 insertions(+), 21 deletions(-) diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt index 56c77c1..ab96bd3 100644 --- a/Help/command/FIND_XXX.txt +++ b/Help/command/FIND_XXX.txt @@ -11,8 +11,8 @@ The general signature is: |FIND_XXX| ( name | |NAMES| - [HINTS [path | ENV var]... ] - [PATHS [path | ENV var]... ] + [HINTS [path | ENV var]...] + [PATHS [path | ENV var]...] [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] [PATH_SUFFIXES suffix1 [suffix2 ...]] [VALIDATOR function] diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst index b099835..b574cba 100644 --- a/Help/command/add_custom_target.rst +++ b/Help/command/add_custom_target.rst @@ -7,7 +7,7 @@ Add a target with no output so it will always be built. add_custom_target(Name [ALL] [command1 [args1...]] [COMMAND command2 [args2...] ...] - [DEPENDS depend depend depend ... ] + [DEPENDS depend depend depend ...] [BYPRODUCTS [files...]] [WORKING_DIRECTORY dir] [COMMENT comment] diff --git a/Help/command/block.rst b/Help/command/block.rst index 4c6e111..da9c483 100644 --- a/Help/command/block.rst +++ b/Help/command/block.rst @@ -7,7 +7,7 @@ Evaluate a group of commands with a dedicated variable and/or policy scope. .. code-block:: cmake - block([SCOPE_FOR [POLICIES] [VARIABLES] ] [PROPAGATE ...]) + block([SCOPE_FOR [POLICIES] [VARIABLES]] [PROPAGATE ...]) endblock() diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst index 7200c24..546f9ce 100644 --- a/Help/command/configure_file.rst +++ b/Help/command/configure_file.rst @@ -13,7 +13,7 @@ Copy a file to another location and modify its contents. [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS | FILE_PERMISSIONS ...] [COPYONLY] [ESCAPE_QUOTES] [@ONLY] - [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]]) Copies an ```` file to an ```` file while performing `transformations`_ of the input file content. diff --git a/Help/command/file.rst b/Help/command/file.rst index dc9e27b..8a9f6e9 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -211,7 +211,7 @@ Writing [CONDITION ] [TARGET ] [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS | FILE_PERMISSIONS ...] - [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]]) The options are: @@ -293,7 +293,7 @@ Writing file(CONFIGURE OUTPUT CONTENT [ESCAPE_QUOTES] [@ONLY] - [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]]) :target: CONFIGURE .. versionadded:: 3.18 diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 114de1f..0e32a9c 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -260,8 +260,8 @@ Full Signature [BYPASS_PROVIDER] [NAMES name1 [name2 ...]] [CONFIGS config1 [config2 ...]] - [HINTS path1 [path2 ... ]] - [PATHS path1 [path2 ... ]] + [HINTS path1 [path2 ...]] + [PATHS path1 [path2 ...]] [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] [PATH_SUFFIXES suffix1 [suffix2 ...]] [NO_DEFAULT_PATH] diff --git a/Help/command/fltk_wrap_ui.rst b/Help/command/fltk_wrap_ui.rst index 6675272..448354e 100644 --- a/Help/command/fltk_wrap_ui.rst +++ b/Help/command/fltk_wrap_ui.rst @@ -6,7 +6,7 @@ Create FLTK user interfaces Wrappers. .. code-block:: cmake fltk_wrap_ui(resultingLibraryName source1 - source2 ... sourceN ) + source2 ... sourceN) Produce .h and .cxx files for all the .fl and .fld files listed. The resulting .h and .cxx files will be added to a variable named diff --git a/Help/command/list.rst b/Help/command/list.rst index 06b2285..0110021 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -236,7 +236,7 @@ For more information on regular expressions look under list(TRANSFORM GENEX_STRIP ...) :target: TRANSFORM_GENEX_STRIP - :command:`REPLACE `: + :command:`REPLACE ` Match the regular expression as many times as possible and substitute the replacement expression for the match for each element of the list (same semantic as :command:`string(REGEX REPLACE)`). diff --git a/Help/command/subdirs.rst b/Help/command/subdirs.rst index ecc6d1f..2c42a0b 100644 --- a/Help/command/subdirs.rst +++ b/Help/command/subdirs.rst @@ -10,7 +10,7 @@ Add a list of subdirectories to the build. .. code-block:: cmake subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] - [PREORDER] ) + [PREORDER]) Add a list of subdirectories to the build. The :command:`add_subdirectory` command should be used instead of ``subdirs`` although ``subdirs`` will still diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst index 599c6be..050e654 100644 --- a/Help/cpack_gen/rpm.rst +++ b/Help/cpack_gen/rpm.rst @@ -526,7 +526,7 @@ List of CPack RPM generator specific variables: May be set by the user in order to specify a USER binary spec file to be used by the CPack RPM generator instead of generating the file. - The specified file will be processed by configure_file( @ONLY). + The specified file will be processed by configure_file(@ONLY). .. variable:: CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE diff --git a/Help/guide/importing-exporting/index.rst b/Help/guide/importing-exporting/index.rst index 89b8554..cee7909 100644 --- a/Help/guide/importing-exporting/index.rst +++ b/Help/guide/importing-exporting/index.rst @@ -319,7 +319,7 @@ were built in its own tree. For example: include(GNUInstallDirs) include(${INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/cmake/MathFunctions/MathFunctionTargets.cmake) - add_executable(myexe src1.c src2.c ) + add_executable(myexe src1.c src2.c) target_link_libraries(myexe PRIVATE MathFunctions::MathFunctions) Line 2 loads the target CMake file. Although we only exported a single diff --git a/Help/guide/tutorial/Complete/CMakeLists.txt b/Help/guide/tutorial/Complete/CMakeLists.txt index 548a82d..181c25e 100644 --- a/Help/guide/tutorial/Complete/CMakeLists.txt +++ b/Help/guide/tutorial/Complete/CMakeLists.txt @@ -121,7 +121,7 @@ install(FILES ) # generate the export targets for the build tree -# needs to be after the install(TARGETS ) command +# needs to be after the install(TARGETS) command export(EXPORT MathFunctionsTargets FILE "${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsTargets.cmake" ) diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 8ebde21..e20cb9c 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -405,7 +405,7 @@ Options ``json-v1`` Prints each line as a separate JSON document. Each document is - separated by a newline ( ``\n`` ). It is guaranteed that no + separated by a newline (``\n``). It is guaranteed that no newline characters will be present inside a JSON document. .. code-block:: json diff --git a/Help/prop_cache/TYPE.rst b/Help/prop_cache/TYPE.rst index 2a7dc31..e004c75 100644 --- a/Help/prop_cache/TYPE.rst +++ b/Help/prop_cache/TYPE.rst @@ -21,4 +21,4 @@ determine the widget type. Valid ``TYPE`` values are: ================= ======================================== Generally the ``TYPE`` of a cache entry should be set by the command which -creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.). +creates it (:command:`set`, :command:`option`, :command:`find_library`, etc.). diff --git a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst index ef17aad..fec98f6 100644 --- a/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst +++ b/Help/prop_tgt/AUTOMOC_DEPEND_FILTERS.rst @@ -58,7 +58,7 @@ In ``CMakeLists.txt`` we add a filter to .. code-block:: c++ - list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS + list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS "JSON_FILE_MACRO" "[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\"" ) diff --git a/Modules/CMakeDetermineVSServicePack.cmake b/Modules/CMakeDetermineVSServicePack.cmake index bff02b6..ed1d0c1 100644 --- a/Modules/CMakeDetermineVSServicePack.cmake +++ b/Modules/CMakeDetermineVSServicePack.cmake @@ -21,8 +21,8 @@ Usage: if(MSVC) include(CMakeDetermineVSServicePack) - DetermineVSServicePack( my_service_pack ) - if( my_service_pack ) + DetermineVSServicePack(my_service_pack) + if(my_service_pack) message(STATUS "Detected: ${my_service_pack}") endif() endif() diff --git a/Modules/WriteBasicConfigVersionFile.cmake b/Modules/WriteBasicConfigVersionFile.cmake index 962a2cc..ac6013b 100644 --- a/Modules/WriteBasicConfigVersionFile.cmake +++ b/Modules/WriteBasicConfigVersionFile.cmake @@ -12,7 +12,7 @@ WriteBasicConfigVersionFile .. code-block:: cmake - WRITE_BASIC_CONFIG_VERSION_FILE( filename + WRITE_BASIC_CONFIG_VERSION_FILE(filename [VERSION major.minor.patch] COMPATIBILITY (AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion) [ARCH_INDEPENDENT] -- cgit v0.12 From 969b039f40c08b9e424d441fe4d939f8ae42858d Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Fri, 31 Jan 2025 15:53:45 +0500 Subject: Help: Reference correct variables in 3.6 release notes --- Help/release/3.6.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Help/release/3.6.rst b/Help/release/3.6.rst index 63e3134..92b1012 100644 --- a/Help/release/3.6.rst +++ b/Help/release/3.6.rst @@ -225,8 +225,8 @@ CPack package file names, how to specify that rpmbuild should decide on file name format as well as handling of multiple rpm packages generated by a single user defined spec file. - See :variable:`CPACK_RPM_PACKAGE_NAME` and - :variable:`CPACK_RPM__PACKAGE_NAME`. + See :variable:`CPACK_RPM_FILE_NAME` and + :variable:`CPACK_RPM__FILE_NAME`. * The :cpack_gen:`CPack RPM Generator` learned how to correctly handle symlinks that are pointing outside generated packages. -- cgit v0.12 From bbbf3536c924d849e6bb714fde5ea6b388f8cce8 Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Fri, 31 Jan 2025 19:19:16 +0500 Subject: Help: Make sure all deprecated utility modules have a notice --- Help/manual/cmake-modules.7.rst | 4 ++-- Modules/CMakeParseArguments.cmake | 2 ++ Modules/SquishTestScript.cmake | 5 +---- Modules/UsePkgConfig.cmake | 5 ++--- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst index 9f014e1..7f61493 100644 --- a/Help/manual/cmake-modules.7.rst +++ b/Help/manual/cmake-modules.7.rst @@ -85,7 +85,6 @@ These modules are loaded using the :command:`include` command. /module/InstallRequiredSystemLibraries /module/ProcessorCount /module/SelectLibraryConfigurations - /module/SquishTestScript /module/TestForANSIForScope /module/TestForANSIStreamHeaders /module/TestForSSTREAM @@ -275,12 +274,13 @@ Deprecated Utility Modules /module/Documentation /module/GetPrerequisites /module/MacroAddFileDependencies + /module/SquishTestScript /module/TestBigEndian /module/TestCXXAcceptsFlag + /module/Use_wxWindows /module/UseJavaClassFilelist /module/UseJavaSymlinks /module/UsePkgConfig - /module/Use_wxWindows /module/WriteBasicConfigVersionFile /module/WriteCompilerDetectionHeader diff --git a/Modules/CMakeParseArguments.cmake b/Modules/CMakeParseArguments.cmake index c753b7f..de9a9eb 100644 --- a/Modules/CMakeParseArguments.cmake +++ b/Modules/CMakeParseArguments.cmake @@ -5,6 +5,8 @@ CMakeParseArguments ------------------- +.. deprecated:: 3.5 + This module once implemented the :command:`cmake_parse_arguments` command that is now implemented natively by CMake. It is now an empty placeholder for compatibility with projects that include it to get the command from diff --git a/Modules/SquishTestScript.cmake b/Modules/SquishTestScript.cmake index b0cb4af..d3f8ebf 100644 --- a/Modules/SquishTestScript.cmake +++ b/Modules/SquishTestScript.cmake @@ -4,10 +4,7 @@ #[=======================================================================[.rst: SquishTestScript ---------------- - - - - +.. deprecated:: 3.0 This script launches a GUI test using Squish. You should not call the script directly; instead, you should access it via the SQUISH_ADD_TEST diff --git a/Modules/UsePkgConfig.cmake b/Modules/UsePkgConfig.cmake index fdf632a..1397889 100644 --- a/Modules/UsePkgConfig.cmake +++ b/Modules/UsePkgConfig.cmake @@ -5,9 +5,8 @@ UsePkgConfig ------------ -Obsolete pkg-config module for CMake, use FindPkgConfig instead. - - +.. deprecated:: 3.0 + Use :module:`FindPkgConfig` instead. This module defines the following macro: -- cgit v0.12 From d13855595959df937f27355887e1e20d7d58ddce Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Fri, 31 Jan 2025 18:32:53 +0500 Subject: Help: Use Title Case for all "Imported Targets" sections --- Modules/FindALSA.cmake | 2 +- Modules/FindBLAS.cmake | 2 +- Modules/FindBZip2.cmake | 2 +- Modules/FindCUDAToolkit.cmake | 2 +- Modules/FindCURL.cmake | 2 +- Modules/FindCups.cmake | 2 +- Modules/FindDevIL.cmake | 2 +- Modules/FindGDAL.cmake | 2 +- Modules/FindGIF.cmake | 2 +- Modules/FindGLUT.cmake | 2 +- Modules/FindGTest.cmake | 2 +- Modules/FindGnuTLS.cmake | 2 +- Modules/FindImageMagick.cmake | 2 +- Modules/FindJPEG.cmake | 2 +- Modules/FindJasper.cmake | 2 +- Modules/FindLAPACK.cmake | 2 +- Modules/FindLibXml2.cmake | 2 +- Modules/FindLibXslt.cmake | 2 +- Modules/FindMatlab.cmake | 2 +- Modules/FindODBC.cmake | 2 +- Modules/FindOpenAL.cmake | 2 +- Modules/FindOpenCL.cmake | 2 +- Modules/FindOpenGL.cmake | 2 +- Modules/FindOpenSP.cmake | 2 +- Modules/FindPNG.cmake | 2 +- Modules/FindPostgreSQL.cmake | 2 +- Modules/FindQt4.cmake | 2 +- Modules/FindSDL.cmake | 2 +- Modules/FindSQLite3.cmake | 2 +- Modules/FindTIFF.cmake | 2 +- Modules/FindVulkan.cmake | 2 +- Modules/FindXalanC.cmake | 2 +- Modules/FindXercesC.cmake | 2 +- Modules/FindZLIB.cmake | 2 +- Modules/FindwxWidgets.cmake | 2 +- 35 files changed, 35 insertions(+), 35 deletions(-) diff --git a/Modules/FindALSA.cmake b/Modules/FindALSA.cmake index f662c64..8ee20b7 100644 --- a/Modules/FindALSA.cmake +++ b/Modules/FindALSA.cmake @@ -9,7 +9,7 @@ Find Advanced Linux Sound Architecture (ALSA) Find the alsa libraries (``asound``) -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.12 diff --git a/Modules/FindBLAS.cmake b/Modules/FindBLAS.cmake index 2a20d33..6d60c9d 100644 --- a/Modules/FindBLAS.cmake +++ b/Modules/FindBLAS.cmake @@ -54,7 +54,7 @@ The following variables may be set to influence this module's behavior: Search for any BLAS/LAPACK. Most likely, a BLAS/LAPACK with 32-bit integer interfaces will be found. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` targets: diff --git a/Modules/FindBZip2.cmake b/Modules/FindBZip2.cmake index 96eae44..133f97a 100644 --- a/Modules/FindBZip2.cmake +++ b/Modules/FindBZip2.cmake @@ -7,7 +7,7 @@ FindBZip2 Try to find BZip2 -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.12 diff --git a/Modules/FindCUDAToolkit.cmake b/Modules/FindCUDAToolkit.cmake index 220a6de..c0877cc 100644 --- a/Modules/FindCUDAToolkit.cmake +++ b/Modules/FindCUDAToolkit.cmake @@ -102,7 +102,7 @@ Options If specified, the CUDA Toolkit is considered found only if the exact ``VERSION`` specified is recovered. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ An :ref:`imported target ` named ``CUDA::toolkit`` is provided. diff --git a/Modules/FindCURL.cmake b/Modules/FindCURL.cmake index 9f1d2cd..aaed590 100644 --- a/Modules/FindCURL.cmake +++ b/Modules/FindCURL.cmake @@ -18,7 +18,7 @@ Find the native CURL headers and libraries. FEATURES: SSL IPv6 UnixSockets libz AsynchDNS IDN GSS-API PSL SPNEGO Kerberos NTLM NTLM_WB TLS-SRP HTTP2 HTTPS-proxy -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.12 diff --git a/Modules/FindCups.cmake b/Modules/FindCups.cmake index 2c79cf4..76ff504 100644 --- a/Modules/FindCups.cmake +++ b/Modules/FindCups.cmake @@ -10,7 +10,7 @@ Find the Common UNIX Printing System (CUPS). Set ``CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE`` to ``TRUE`` if you need a version which features this function (i.e. at least ``1.1.19``) -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.15 diff --git a/Modules/FindDevIL.cmake b/Modules/FindDevIL.cmake index 5481322..0c8bfb3 100644 --- a/Modules/FindDevIL.cmake +++ b/Modules/FindDevIL.cmake @@ -8,7 +8,7 @@ FindDevIL This module locates the Developer's Image Library, `DevIL `_. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.21 diff --git a/Modules/FindGDAL.cmake b/Modules/FindGDAL.cmake index 58c5735..8604911 100644 --- a/Modules/FindGDAL.cmake +++ b/Modules/FindGDAL.cmake @@ -13,7 +13,7 @@ Find Geospatial Data Abstraction Library (GDAL). find module. For further details, see `GDAL's documentation on CMake integration `_. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.14 diff --git a/Modules/FindGIF.cmake b/Modules/FindGIF.cmake index 065a24e..5214982 100644 --- a/Modules/FindGIF.cmake +++ b/Modules/FindGIF.cmake @@ -7,7 +7,7 @@ FindGIF This finds the Graphics Interchange Format (GIF) library (``giflib``) -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` target: diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake index e2fd0a4..b53aee8 100644 --- a/Modules/FindGLUT.cmake +++ b/Modules/FindGLUT.cmake @@ -7,7 +7,7 @@ FindGLUT Find OpenGL Utility Toolkit (GLUT) library and include files. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.1 diff --git a/Modules/FindGTest.cmake b/Modules/FindGTest.cmake index 5fad3f2..cd2b3bb 100644 --- a/Modules/FindGTest.cmake +++ b/Modules/FindGTest.cmake @@ -10,7 +10,7 @@ Locate the Google C++ Testing Framework. .. versionadded:: 3.20 Upstream ``GTestConfig.cmake`` is used if possible. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.20 diff --git a/Modules/FindGnuTLS.cmake b/Modules/FindGnuTLS.cmake index 0cb8512..0d65dca 100644 --- a/Modules/FindGnuTLS.cmake +++ b/Modules/FindGnuTLS.cmake @@ -7,7 +7,7 @@ FindGnuTLS Find the GNU Transport Layer Security library (gnutls) -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.16 diff --git a/Modules/FindImageMagick.cmake b/Modules/FindImageMagick.cmake index 8866b47..ebcc710 100644 --- a/Modules/FindImageMagick.cmake +++ b/Modules/FindImageMagick.cmake @@ -39,7 +39,7 @@ There are also components for the following ImageMagick APIs: * ``MagickCore``: ImageMagick MagickCore low-level C API, if found. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.26 diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake index b50c4c9..35b9204 100644 --- a/Modules/FindJPEG.cmake +++ b/Modules/FindJPEG.cmake @@ -7,7 +7,7 @@ FindJPEG Find the Joint Photographic Experts Group (JPEG) library (``libjpeg``) -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.12 diff --git a/Modules/FindJasper.cmake b/Modules/FindJasper.cmake index 7b74b41..67b955f 100644 --- a/Modules/FindJasper.cmake +++ b/Modules/FindJasper.cmake @@ -7,7 +7,7 @@ FindJasper Find the Jasper JPEG2000 library. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ ``Jasper::Jasper`` diff --git a/Modules/FindLAPACK.cmake b/Modules/FindLAPACK.cmake index 74d30a4..8c9d0b4 100644 --- a/Modules/FindLAPACK.cmake +++ b/Modules/FindLAPACK.cmake @@ -55,7 +55,7 @@ The following variables may be set to influence this module's behavior: Search for any BLAS/LAPACK. Most likely, a BLAS/LAPACK with 32-bit integer interfaces will be found. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` targets: diff --git a/Modules/FindLibXml2.cmake b/Modules/FindLibXml2.cmake index 12d7dfa..14d0634 100644 --- a/Modules/FindLibXml2.cmake +++ b/Modules/FindLibXml2.cmake @@ -7,7 +7,7 @@ FindLibXml2 Find the XML processing library (libxml2). -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.12 diff --git a/Modules/FindLibXslt.cmake b/Modules/FindLibXslt.cmake index 3109e30..6b311d4 100644 --- a/Modules/FindLibXslt.cmake +++ b/Modules/FindLibXslt.cmake @@ -8,7 +8,7 @@ FindLibXslt Find the XSL Transformations, Extensible Stylesheet Language Transformations (XSLT) library (LibXslt) -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.18 diff --git a/Modules/FindMatlab.cmake b/Modules/FindMatlab.cmake index ce44afa..a9a10ba 100644 --- a/Modules/FindMatlab.cmake +++ b/Modules/FindMatlab.cmake @@ -110,7 +110,7 @@ behavior: additional versions of Matlab for the automatic retrieval of the installed versions. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.22 diff --git a/Modules/FindODBC.cmake b/Modules/FindODBC.cmake index 884653c..f3adb8a 100644 --- a/Modules/FindODBC.cmake +++ b/Modules/FindODBC.cmake @@ -25,7 +25,7 @@ first from unixODBC, then from iODBC. If no config program found, this module searches for ODBC header and library in list of known locations. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` targets: diff --git a/Modules/FindOpenAL.cmake b/Modules/FindOpenAL.cmake index eb0ba45..8015502 100644 --- a/Modules/FindOpenAL.cmake +++ b/Modules/FindOpenAL.cmake @@ -29,7 +29,7 @@ OpenAL is searched in the following order: 5. Manually compiled framework: ``/Library/Frameworks``. 6. Add-on package: ``/opt``. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.25 diff --git a/Modules/FindOpenCL.cmake b/Modules/FindOpenCL.cmake index 13ff986..697b062 100644 --- a/Modules/FindOpenCL.cmake +++ b/Modules/FindOpenCL.cmake @@ -12,7 +12,7 @@ Finds Open Computing Language (OpenCL) .. versionadded:: 3.10 Detection of OpenCL 2.1 and 2.2. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.7 diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index 58c4406..69faf7e 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -39,7 +39,7 @@ This module respects several optional COMPONENTS: A subset of OpenGL API for embedded systems with more capabilities. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.8 diff --git a/Modules/FindOpenSP.cmake b/Modules/FindOpenSP.cmake index 5cd9570..8f6d50a 100644 --- a/Modules/FindOpenSP.cmake +++ b/Modules/FindOpenSP.cmake @@ -44,7 +44,7 @@ This will define the following variables: ``SP_MULTI_BYTE`` to match this value in order to avoid issues with character decoding. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the :prop_tgt:`IMPORTED` target ``OpenSP::OpenSP``, if diff --git a/Modules/FindPNG.cmake b/Modules/FindPNG.cmake index 3d86724..11d2056 100644 --- a/Modules/FindPNG.cmake +++ b/Modules/FindPNG.cmake @@ -7,7 +7,7 @@ FindPNG Find libpng, the official reference library for the PNG image format. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.5 diff --git a/Modules/FindPostgreSQL.cmake b/Modules/FindPostgreSQL.cmake index 927b9e0..b7dcbb8 100644 --- a/Modules/FindPostgreSQL.cmake +++ b/Modules/FindPostgreSQL.cmake @@ -7,7 +7,7 @@ FindPostgreSQL Find the PostgreSQL installation. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.14 diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake index c4011c0..e58b2e5 100644 --- a/Modules/FindQt4.cmake +++ b/Modules/FindQt4.cmake @@ -203,7 +203,7 @@ more-manual way. Several macros are available to add targets for such uses. same argument to the target_link_libraries call. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ A particular Qt library may be used by using the corresponding diff --git a/Modules/FindSDL.cmake b/Modules/FindSDL.cmake index 3787231..7de8229 100644 --- a/Modules/FindSDL.cmake +++ b/Modules/FindSDL.cmake @@ -8,7 +8,7 @@ FindSDL Locate the SDL library -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.19 diff --git a/Modules/FindSQLite3.cmake b/Modules/FindSQLite3.cmake index 025f5f1..3420538 100644 --- a/Modules/FindSQLite3.cmake +++ b/Modules/FindSQLite3.cmake @@ -9,7 +9,7 @@ FindSQLite3 Find the SQLite libraries, v3 -IMPORTED targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` target: diff --git a/Modules/FindTIFF.cmake b/Modules/FindTIFF.cmake index 510290a..77056d6 100644 --- a/Modules/FindTIFF.cmake +++ b/Modules/FindTIFF.cmake @@ -14,7 +14,7 @@ This module supports the optional component `CXX`, for use with the COMPONENTS argument of the :command:`find_package` command. This component has an associated imported target, as described below. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.5 diff --git a/Modules/FindVulkan.cmake b/Modules/FindVulkan.cmake index 893c097..6c999e3 100644 --- a/Modules/FindVulkan.cmake +++ b/Modules/FindVulkan.cmake @@ -44,7 +44,7 @@ There are corresponding imported targets for each of these. The ``glslc`` and ``glslangValidator`` components are provided even if not explicitly requested (for backward compatibility). -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines :prop_tgt:`IMPORTED` targets if Vulkan has been found: diff --git a/Modules/FindXalanC.cmake b/Modules/FindXalanC.cmake index fc091b3..d519dd7 100644 --- a/Modules/FindXalanC.cmake +++ b/Modules/FindXalanC.cmake @@ -9,7 +9,7 @@ FindXalanC Find the Apache Xalan-C++ XSL transform processor headers and libraries. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ This module defines the following :prop_tgt:`IMPORTED` targets: diff --git a/Modules/FindXercesC.cmake b/Modules/FindXercesC.cmake index bf350b2..7b95cfc 100644 --- a/Modules/FindXercesC.cmake +++ b/Modules/FindXercesC.cmake @@ -9,7 +9,7 @@ FindXercesC Find the Apache Xerces-C++ validating XML parser headers and libraries. -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.5 diff --git a/Modules/FindZLIB.cmake b/Modules/FindZLIB.cmake index ea56e71..a79d9ab 100644 --- a/Modules/FindZLIB.cmake +++ b/Modules/FindZLIB.cmake @@ -7,7 +7,7 @@ FindZLIB Find the native ZLIB includes and library. -IMPORTED Targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.1 diff --git a/Modules/FindwxWidgets.cmake b/Modules/FindwxWidgets.cmake index fc9feb9..84ef567 100644 --- a/Modules/FindwxWidgets.cmake +++ b/Modules/FindwxWidgets.cmake @@ -114,7 +114,7 @@ If wxWidgets is required (i.e., not an optional part): # and for each of your dependent executable/library targets: target_link_libraries( ${wxWidgets_LIBRARIES}) -Imported targets +Imported Targets ^^^^^^^^^^^^^^^^ .. versionadded:: 3.27 -- cgit v0.12 From d1d134534d36adc638e6a642bc1662f04ee3455f Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Fri, 31 Jan 2025 17:43:29 +0500 Subject: Help: Add formatting to FindGettext and FindGnuplot --- Modules/FindGettext.cmake | 94 ++++++++++++++++++++++++++++++----------------- Modules/FindGnuplot.cmake | 20 +++++----- 2 files changed, 70 insertions(+), 44 deletions(-) diff --git a/Modules/FindGettext.cmake b/Modules/FindGettext.cmake index c9937e7..940d2c0 100644 --- a/Modules/FindGettext.cmake +++ b/Modules/FindGettext.cmake @@ -5,57 +5,83 @@ FindGettext ----------- -Find GNU gettext tools +Find GNU gettext tools. -This module looks for the GNU gettext tools. This module defines the -following values: +This module looks for the GNU gettext tools. -:: +Result Variables +^^^^^^^^^^^^^^^^ - GETTEXT_MSGMERGE_EXECUTABLE: the full path to the msgmerge tool. - GETTEXT_MSGFMT_EXECUTABLE: the full path to the msgfmt tool. - GETTEXT_FOUND: True if gettext has been found. - GETTEXT_VERSION_STRING: the version of gettext found (since CMake 2.8.8) +This module defines the following variables: +``GETTEXT_FOUND`` + True if gettext has been found. +``GETTEXT_VERSION_STRING`` + The version of gettext found. -Additionally it provides the following macros: +``GETTEXT_MSGMERGE_EXECUTABLE`` + The full path to the msgmerge tool. -GETTEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ... fileN ) +``GETTEXT_MSGFMT_EXECUTABLE`` + The full path to the msgfmt tool. -:: +Functions +^^^^^^^^^ - This will create a target "translations" which will convert the - given input po files into the binary output mo file. If the - ALL option is used, the translations will also be created when - building the default target. +This module provides several function. -GETTEXT_PROCESS_POT_FILE( [ALL] [INSTALL_DESTINATION ] -LANGUAGES ... ) +.. command:: gettext_create_translations -:: + .. code-block:: cmake - Process the given pot file to mo files. - If INSTALL_DESTINATION is given then automatically install rules will - be created, the language subdirectory will be taken into account - (by default use share/locale/). - If ALL is specified, the pot file is processed when building the all target. - It creates a custom target "potfile". + gettext_create_translations( [ALL] ...) -GETTEXT_PROCESS_PO_FILES( [ALL] [INSTALL_DESTINATION ] -PO_FILES ... ) + This will create a target "translations" which will convert the + given input .po files into the binary output .mo file. Options: -:: + ``ALL`` + The translations will be created when building the default target. - Process the given po files to mo files for the given language. - If INSTALL_DESTINATION is given then automatically install rules will - be created, the language subdirectory will be taken into account - (by default use share/locale/). - If ALL is specified, the po files are processed when building the all target. - It creates a custom target "pofiles". +.. command:: gettext_process_pot_file + + .. code-block:: cmake + + gettext_process_pot_file( [ALL] + [INSTALL_DESTINATION ] + LANGUAGES ...) + + This function creates a custom target "potfile" which processes the given + .pot file to .mo files. Options: + + ``ALL`` + The .pot file will be processed when building the default target. + + ``INSTALL_DESTINATION`` + Install the results into the given directory (``share/locale/`` by + default). The language subdirectory will be taken into account. + +.. command:: gettext_process_po_files + + .. code-block:: cmake + + gettext_process_po_files( [ALL] + [INSTALL_DESTINATION ] + PO_FILES ...) + + This function creates a custom target "pofiles", which processes the given + .po files to .mo files for the given language. Options: + + ``ALL`` + The .po files will be processed when building the default target. + + ``INSTALL_DESTINATION`` + Install the results into the given directory (``share/locale/`` by + default). The language subdirectory will be taken into account . .. versionadded:: 3.2 - If you wish to use the Gettext library (libintl), use :module:`FindIntl`. + If you wish to use the Gettext runtime library (libintl), use + :module:`FindIntl`. #]=======================================================================] find_program(GETTEXT_MSGMERGE_EXECUTABLE msgmerge) diff --git a/Modules/FindGnuplot.cmake b/Modules/FindGnuplot.cmake index f61c406..07cfbd3 100644 --- a/Modules/FindGnuplot.cmake +++ b/Modules/FindGnuplot.cmake @@ -5,21 +5,21 @@ FindGnuplot ----------- -this module looks for gnuplot +This module looks for gnuplot. +Result Variables +^^^^^^^^^^^^^^^^ +``GNUPLOT_FOUND`` + System has Gnuplot. -Once done this will define +``GNUPLOT_EXECUTABLE`` + The Gnuplot executable. -:: +``GNUPLOT_VERSION_STRING`` + The version of Gnuplot found. - GNUPLOT_FOUND - system has Gnuplot - GNUPLOT_EXECUTABLE - the Gnuplot executable - GNUPLOT_VERSION_STRING - the version of Gnuplot found (since CMake 2.8.8) - - - -GNUPLOT_VERSION_STRING will not work for old versions like 3.7.1. + .. note:: Version string detection will not work for old versions like 3.7.1. #]=======================================================================] include(${CMAKE_CURRENT_LIST_DIR}/FindCygwin.cmake) -- cgit v0.12