From 441f2808eca5c1deed7e480ce3043c57c901b33c Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 12 Sep 2013 11:41:36 -0400 Subject: [PATCH] Help: Fix reStructuredText syntax in auto-generated documents --- Help/command/add_executable.rst | 2 +- Help/command/add_library.rst | 2 +- Help/command/configure_file.rst | 2 +- Help/command/export.rst | 2 +- Help/command/foreach.rst | 6 +++--- Help/command/install.rst | 2 +- Help/command/string.rst | 2 +- Help/manual/ccmake.1.rst | 1 + Help/manual/cmake-gui.1.rst | 1 + Help/manual/cmake.1.rst | 1 + Help/manual/cpack.1.rst | 1 + Help/manual/ctest.1.rst | 1 + Help/policy/CMP0022.rst | 6 +++--- Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst | 2 +- Help/prop_tgt/LOCATION.rst | 2 +- Help/prop_tgt/LOCATION_CONFIG.rst | 2 +- Modules/ExternalProject.cmake | 2 +- Modules/FindGTest.cmake | 2 -- Modules/Use_wxWindows.cmake | 1 - 19 files changed, 21 insertions(+), 19 deletions(-) diff --git a/Help/command/add_executable.rst b/Help/command/add_executable.rst index 656af7c51..d6fd929c0 100644 --- a/Help/command/add_executable.rst +++ b/Help/command/add_executable.rst @@ -49,7 +49,7 @@ the GLOBAL option extends visibility. It may be referenced like any target built within the project. IMPORTED executables are useful for convenient reference from commands like add_custom_command. Details about the imported executable are specified by setting properties -whose names begin in "IMPORTED_". The most important such property is +whose names begin in ``IMPORTED_``. The most important such property is IMPORTED_LOCATION (and its per-configuration version IMPORTED_LOCATION_) which specifies the location of the main executable file on disk. See documentation of the IMPORTED_* diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index 174f126fe..45f1102cb 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -54,7 +54,7 @@ GLOBAL option extends visibility. It may be referenced like any target built within the project. IMPORTED libraries are useful for convenient reference from commands like target_link_libraries. Details about the imported library are specified by setting properties -whose names begin in "IMPORTED_". The most important such property is +whose names begin in ``IMPORTED_``. The most important such property is IMPORTED_LOCATION (and its per-configuration version IMPORTED_LOCATION_) which specifies the location of the main library file on disk. See documentation of the IMPORTED_* properties diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst index 5e5a33a2e..70357f240 100644 --- a/Help/command/configure_file.rst +++ b/Help/command/configure_file.rst @@ -31,7 +31,7 @@ will be replaced and ${VAR} will be ignored. This is useful for configuring scripts that use ${VAR}. Input file lines of the form "#cmakedefine VAR ..." will be replaced -with either "#define VAR ..." or "/* #undef VAR */" depending on +with either "#define VAR ..." or ``/* #undef VAR */`` depending on whether VAR is set in CMake to any value not considered a false constant by the if() command. (Content of "...", if any, is processed as above.) Input file lines of the form "#cmakedefine01 VAR" will be diff --git a/Help/command/export.rst b/Help/command/export.rst index d9f63f014..c29334001 100644 --- a/Help/command/export.rst +++ b/Help/command/export.rst @@ -18,7 +18,7 @@ names written to the file. If the APPEND option is given the generated code will be appended to the file instead of overwriting it. The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the contents of the properties matching -(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)? to be exported, when +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?`` to be exported, when policy CMP0022 is NEW. If a library target is included in the export but a target to which it links is not included the behavior is unspecified. diff --git a/Help/command/foreach.rst b/Help/command/foreach.rst index 9ac70b34a..8f9710c50 100644 --- a/Help/command/foreach.rst +++ b/Help/command/foreach.rst @@ -27,13 +27,13 @@ Foreach can also iterate over a generated range of numbers. There are three types of this iteration: * When specifying single number, the range will have elements 0 to -"total". + "total". * When specifying two numbers, the range will have elements from the -first number to the second number. + first number to the second number. * The third optional number is the increment used to iterate from the -first number to the second number. + first number to the second number. :: diff --git a/Help/command/install.rst b/Help/command/install.rst index 9b27caee8..a463a60eb 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -287,7 +287,7 @@ when one of the named configurations is installed. Additionally, the generated import file will reference only the matching target configurations. The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the contents of the properties matching -(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)? to be exported, when +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?`` to be exported, when policy CMP0022 is NEW. If a COMPONENT option is specified that does not match that given to the targets associated with the behavior is undefined. If a library target is included in the export diff --git a/Help/command/string.rst b/Help/command/string.rst index c191c6336..1e18ca619 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -106,7 +106,7 @@ The following characters have special meaning in regular expressions: by all regular expression-related commands, including e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9). -*, + and ? have higher precedence than concatenation. | has lower +``*``, ``+`` and ``?`` have higher precedence than concatenation. | has lower precedence than concatenation. This means that the regular expression "^ab+d$" matches "abbd" but not "ababd", and the regular expression "^(ab|cd)$" matches "ab" but not "abd". diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index cde51a653..b5146e71d 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -108,6 +108,7 @@ native tool on their platform. * ``--version,-version,/V [file]``: Show program name/version banner and exit. If a file is specified, the version is written into it. + :: CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 6edfe27c8..b4f295f6a 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -50,6 +50,7 @@ native tool on their platform. * ``--version,-version,/V [file]``: Show program name/version banner and exit. If a file is specified, the version is written into it. + The following generators are available on this platform: :: diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 1147ab8b5..ace93074e 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -350,6 +350,7 @@ native tool on their platform. * ``--version,-version,/V [file]``: Show program name/version banner and exit. If a file is specified, the version is written into it. + The following generators are available on this platform: :: diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index d9f46f42c..401283c54 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -146,6 +146,7 @@ native tool on their platform. * ``--version,-version,/V [file]``: Show program name/version banner and exit. If a file is specified, the version is written into it. + :: CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 82a839607..1ce59aef2 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -343,6 +343,7 @@ program will run the tests and report results. * ``--version,-version,/V [file]``: Show program name/version banner and exit. If a file is specified, the version is written into it. + The following generators are available on this platform: :: diff --git a/Help/policy/CMP0022.rst b/Help/policy/CMP0022.rst index 78c688a7a..d068c555a 100644 --- a/Help/policy/CMP0022.rst +++ b/Help/policy/CMP0022.rst @@ -4,9 +4,9 @@ CMP0022 INTERFACE_LINK_LIBRARIES defines the link interface. CMake 2.8.11 constructed the 'link interface' of a target from -properties matching (IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?. +properties matching ``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?``. The modern way to specify config-sensitive content is to use generator -expressions and the IMPORTED_ prefix makes uniform processing of the +expressions and the ``IMPORTED_`` prefix makes uniform processing of the link interface with generator expressions impossible. The INTERFACE_LINK_LIBRARIES target property was introduced as a replacement in CMake 2.8.12. This new property is named consistently @@ -26,7 +26,7 @@ The OLD behavior for this policy is to ignore the INTERFACE_LINK_LIBRARIES property for in-build targets. The NEW behavior for this policy is to use the INTERFACE_LINK_LIBRARIES property for in-build targets, and ignore the old properties matching -(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?. +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_)?``. This policy was introduced in CMake version 2.8.12. CMake version |release| warns when the policy is not set and uses OLD behavior. Use diff --git a/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst index 9fe890c3e..c83fb8b67 100644 --- a/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst +++ b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst @@ -1,7 +1,7 @@ AUTOMOC_TARGETS_FOLDER ---------------------- -Name of FOLDER for *_automoc targets that are added automatically by CMake for targets for which AUTOMOC is enabled. +Name of FOLDER for ``*_automoc`` targets that are added automatically by CMake for targets for which AUTOMOC is enabled. If not set, CMake uses the FOLDER property of the parent target as a default value for this property. See also the documentation for the diff --git a/Help/prop_tgt/LOCATION.rst b/Help/prop_tgt/LOCATION.rst index bdcb1df9a..16d5696e5 100644 --- a/Help/prop_tgt/LOCATION.rst +++ b/Help/prop_tgt/LOCATION.rst @@ -22,6 +22,6 @@ Therefore this property is not needed for creating custom commands. Do not set properties that affect the location of a target after reading this property. These include properties whose names match "(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?", -"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow this rule is not diagnosed and leaves the location of the target undefined. diff --git a/Help/prop_tgt/LOCATION_CONFIG.rst b/Help/prop_tgt/LOCATION_CONFIG.rst index 5c4d75bdc..ac6bdb786 100644 --- a/Help/prop_tgt/LOCATION_CONFIG.rst +++ b/Help/prop_tgt/LOCATION_CONFIG.rst @@ -15,6 +15,6 @@ explicitly. Do not set properties that affect the location of a target after reading this property. These include properties whose names match "(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_)?", -"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow this rule is not diagnosed and leaves the location of the target undefined. diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index b8499b3cb..84fa61377 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -71,7 +71,7 @@ # [STEP_TARGETS st1 st2 ...] # Generate custom targets for these steps # ) # -# The *_DIR options specify directories for the project, with default +# The ``*_DIR`` options specify directories for the project, with default # directories computed as follows. If the PREFIX option is given to # ExternalProject_Add() or the EP_PREFIX directory property is set, then # an external project is built and installed under the specified prefix: diff --git a/Modules/FindGTest.cmake b/Modules/FindGTest.cmake index 2c745404e..c00a750f1 100644 --- a/Modules/FindGTest.cmake +++ b/Modules/FindGTest.cmake @@ -2,8 +2,6 @@ # FindGTest # --------- # -# -------------------- -# # Locate the Google C++ Testing Framework. # # Defines the following variables: diff --git a/Modules/Use_wxWindows.cmake b/Modules/Use_wxWindows.cmake index d21c303e5..d3025ac12 100644 --- a/Modules/Use_wxWindows.cmake +++ b/Modules/Use_wxWindows.cmake @@ -2,7 +2,6 @@ # Use_wxWindows # ------------- # -# --------------------------------------------------- # # #