Explorar el Código

Help: Fix reStructuredText syntax in auto-generated documents

Brad King hace 12 años
padre
commit
441f2808ec

+ 1 - 1
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_<CONFIG>) which specifies the location of the main
 executable file on disk.  See documentation of the IMPORTED_*

+ 1 - 1
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_<CONFIG>) which specifies the location of the main
 library file on disk.  See documentation of the IMPORTED_* properties

+ 1 - 1
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

+ 1 - 1
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(_<CONFIG>)? to be exported, when
+``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?`` 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.

+ 3 - 3
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.
 
 ::
 

+ 1 - 1
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(_<CONFIG>)? to be exported, when
+``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?`` 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 <export-name> the
 behavior is undefined.  If a library target is included in the export

+ 1 - 1
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".

+ 1 - 0
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.

+ 1 - 0
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:
 
 ::

+ 1 - 0
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:
 
 ::

+ 1 - 0
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.

+ 1 - 0
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:
 
 ::

+ 3 - 3
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(_<CONFIG>)?.
+properties matching ``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?``.
 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(_<CONFIG>)?.
+``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?``.
 
 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

+ 1 - 1
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

+ 1 - 1
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)(_<CONFIG>)?",
-"(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.

+ 1 - 1
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)(_<CONFIG>)?",
-"(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.

+ 1 - 1
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:

+ 0 - 2
Modules/FindGTest.cmake

@@ -2,8 +2,6 @@
 # FindGTest
 # ---------
 #
-# --------------------
-#
 # Locate the Google C++ Testing Framework.
 #
 # Defines the following variables:

+ 0 - 1
Modules/Use_wxWindows.cmake

@@ -2,7 +2,6 @@
 # Use_wxWindows
 # -------------
 #
-# ---------------------------------------------------
 #
 #
 #