Browse Source

Merge branch 'docs-misc-trivial-cleanups' into release-3.15

Merge-request: !3498
Craig Scott 6 years ago
parent
commit
12e46dc413

+ 3 - 1
Help/command/execute_process.rst

@@ -80,7 +80,9 @@ Options:
 
 ``COMMAND_ECHO <where>``
  The command being run will be echo'ed to ``<where>`` with ``<where>``
- being set to ``STDERR``|``STDOUT``|``NONE``.
+ being set to one of ``STDERR``, ``STDOUT`` or ``NONE``.
+ See the :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable for a way
+ to control the default behavior when this option is not present.
 
 ``ENCODING <name>``
  On Windows, the encoding that is used to decode output from the process.

+ 27 - 30
Help/command/list.rst

@@ -207,84 +207,81 @@ but if duplicates are encountered, only the first instance is preserved.
                         [OUTPUT_VARIABLE <output variable>])
 
 Transforms the list by applying an action to all or, by specifying a
-``<SELECTOR>``, to the selected elements of the list, storing result in-place
-or in the specified output variable.
+``<SELECTOR>``, to the selected elements of the list, storing the result
+in-place or in the specified output variable.
 
 .. note::
 
-   ``TRANSFORM`` sub-command does not change the number of elements of the
+   The ``TRANSFORM`` sub-command does not change the number of elements in the
    list. If a ``<SELECTOR>`` is specified, only some elements will be changed,
-   the other ones will remain same as before the transformation.
+   the other ones will remain the same as before the transformation.
 
-``<ACTION>`` specify the action to apply to the elements of list.
-The actions have exactly the same semantics as sub-commands of
-:command:`string` command.
-
-The ``<ACTION>`` may be one of:
+``<ACTION>`` specifies the action to apply to the elements of the list.
+The actions have exactly the same semantics as sub-commands of the
+:command:`string` command.  ``<ACTION>`` must be one of the following:
 
 ``APPEND``, ``PREPEND``: Append, prepend specified value to each element of
 the list.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> <APPEND|PREPEND> <value> ...)
+    list(TRANSFORM <list> <APPEND|PREPEND> <value> ...)
 
 ``TOUPPER``, ``TOLOWER``: Convert each element of the list to upper, lower
 characters.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> <TOLOWER|TOUPPER> ...)
+    list(TRANSFORM <list> <TOLOWER|TOUPPER> ...)
 
 ``STRIP``: Remove leading and trailing spaces from each element of the
 list.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> STRIP ...)
+    list(TRANSFORM <list> STRIP ...)
 
 ``GENEX_STRIP``: Strip any
 :manual:`generator expressions <cmake-generator-expressions(7)>` from each
 element of the list.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> GENEX_STRIP ...)
+    list(TRANSFORM <list> GENEX_STRIP ...)
 
 ``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 ``REGEX REPLACE`` from :command:`string` command).
 
-.. code-block:: cmake
-
-  list(TRANSFORM <list> REPLACE <regular_expression>
-                                <replace_expression> ...)
+  .. code-block:: cmake
 
-``<SELECTOR>`` select which elements of the list will be transformed. Only one
-type of selector can be specified at a time.
+    list(TRANSFORM <list> REPLACE <regular_expression>
+                                  <replace_expression> ...)
 
-The ``<SELECTOR>`` may be one of:
+``<SELECTOR>`` determines which elements of the list will be transformed.
+Only one type of selector can be specified at a time.  When given,
+``<SELECTOR>`` must be one of the following:
 
 ``AT``: Specify a list of indexes.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> <ACTION> AT <index> [<index> ...] ...)
+    list(TRANSFORM <list> <ACTION> AT <index> [<index> ...] ...)
 
 ``FOR``: Specify a range with, optionally, an increment used to iterate over
 the range.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> <ACTION> FOR <start> <stop> [<step>] ...)
+    list(TRANSFORM <list> <ACTION> FOR <start> <stop> [<step>] ...)
 
 ``REGEX``: Specify a regular expression. Only elements matching the regular
 expression will be transformed.
 
-.. code-block:: cmake
+  .. code-block:: cmake
 
-  list(TRANSFORM <list> <ACTION> REGEX <regular_expression> ...)
+    list(TRANSFORM <list> <ACTION> REGEX <regular_expression> ...)
 
 
 Ordering

+ 5 - 4
Help/manual/cmake.1.rst

@@ -290,7 +290,8 @@ following options:
   value of ``1`` can be used to limit to a single job.
 
 ``--target <tgt>..., -t <tgt>...``
-  Build ``<tgt>`` instead of default targets.  May be specified multiple times.
+  Build ``<tgt>`` instead of the default target.  Multiple targets may be
+  given, separated by spaces.
 
 ``--config <cfg>``
   For multi-configuration tools, choose configuration ``<cfg>``.
@@ -333,16 +334,16 @@ The options are:
   Project binary directory to install. This is required and must be first.
 
 ``--config <cfg>``
-  For multi-configuration tools, choose configuration ``<cfg>``.
+  For multi-configuration generators, choose configuration ``<cfg>``.
 
 ``--component <comp>``
   Component-based install. Only install component ``<comp>``.
 
 ``--prefix <prefix>``
-  The installation prefix :variable:`CMAKE_INSTALL_PREFIX`.
+  Override the installation prefix, :variable:`CMAKE_INSTALL_PREFIX`.
 
 ``--strip``
-  Strip before installing by setting ``CMAKE_INSTALL_DO_STRIP``.
+  Strip before installing.
 
 ``-v, --verbose``
   Enable verbose output.

+ 1 - 1
Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst

@@ -13,5 +13,5 @@ part of the ``make clean`` target.
 Arguments to :prop_dir:`ADDITIONAL_MAKE_CLEAN_FILES` may use
 :manual:`generator expressions <cmake-generator-expressions(7)>`.
 
-This property only works for the the Makefile generators.
+This property only works for the Makefile generators.
 It is ignored on other generators.

+ 3 - 3
Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst

@@ -1,6 +1,6 @@
 CMAKE_EXECUTE_PROCESS_COMMAND_ECHO
 ----------------------------------
 
-If this variable is set to ``STDERR``|``STDOUT``|``NONE`` then commands in
-:command:`execute_process` calls will be printed to either stderr or stdout
-or not at all.
+If this variable is set to ``STDERR``, ``STDOUT`` or ``NONE`` then commands
+in :command:`execute_process` calls will be printed to either stderr or
+stdout or not at all.