From 074fbdb73f052212003ef65804c3532380c76dcd Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 29 Jun 2019 22:05:22 +1000 Subject: Help: Clean up trivial typos and grammar --- Help/command/execute_process.rst | 2 +- Help/command/list.rst | 23 ++++++++++------------ Help/manual/cmake.1.rst | 4 ++-- Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst | 2 +- .../CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst | 6 +++--- 5 files changed, 17 insertions(+), 20 deletions(-) diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index e6ad037..b11d1ac 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -80,7 +80,7 @@ Options: ``COMMAND_ECHO `` The command being run will be echo'ed to ```` with ```` - being set to ``STDERR``|``STDOUT``|``NONE``. + being set to one of ``STDERR``, ``STDOUT`` or ``NONE``. ``ENCODING `` On Windows, the encoding that is used to decode output from the process. diff --git a/Help/command/list.rst b/Help/command/list.rst index 4444af7..866a597 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -207,20 +207,18 @@ but if duplicates are encountered, only the first instance is preserved. [OUTPUT_VARIABLE ]) Transforms the list by applying an action to all or, by specifying a -````, to the selected elements of the list, storing result in-place -or in the specified output variable. +````, 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 ```` 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. -```` 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 ```` may be one of: +```` 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. ```` must be one of the following: ``APPEND``, ``PREPEND``: Append, prepend specified value to each element of the list. @@ -261,10 +259,9 @@ of the list list(TRANSFORM REPLACE ...) -```` select which elements of the list will be transformed. Only one -type of selector can be specified at a time. - -The ```` may be one of: +```` determines which elements of the list will be transformed. +Only one type of selector can be specified at a time. When given, +```` must be one of the following: ``AT``: Specify a list of indexes. diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 13cba71..dccf797 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -333,13 +333,13 @@ The options are: Project binary directory to install. This is required and must be first. ``--config `` - For multi-configuration tools, choose configuration ````. + For multi-configuration generators, choose configuration ````. ``--component `` Component-based install. Only install component ````. ``--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``. diff --git a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst index 893a298..b6f6160 100644 --- a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst +++ b/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 `. -This property only works for the the Makefile generators. +This property only works for the Makefile generators. It is ignored on other generators. diff --git a/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst b/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst index 4a3121c..76561d8 100644 --- a/Help/variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO.rst +++ b/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. -- cgit v0.12 From 9cc6befe1b7de68910787c5732e436393de2bdfc Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sun, 30 Jun 2019 19:43:11 +1000 Subject: Help: Improve formatting of list(TRANSFORM) sub-options --- Help/command/list.rst | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Help/command/list.rst b/Help/command/list.rst index 866a597..39e7e2a 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -223,41 +223,41 @@ The actions have exactly the same semantics as sub-commands of the ``APPEND``, ``PREPEND``: Append, prepend specified value to each element of the list. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM ...) + list(TRANSFORM ...) ``TOUPPER``, ``TOLOWER``: Convert each element of the list to upper, lower characters. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM ...) + list(TRANSFORM ...) ``STRIP``: Remove leading and trailing spaces from each element of the list. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM STRIP ...) + list(TRANSFORM STRIP ...) ``GENEX_STRIP``: Strip any :manual:`generator expressions ` from each element of the list. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM GENEX_STRIP ...) + list(TRANSFORM 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 + .. code-block:: cmake - list(TRANSFORM REPLACE - ...) + list(TRANSFORM REPLACE + ...) ```` determines which elements of the list will be transformed. Only one type of selector can be specified at a time. When given, @@ -265,23 +265,23 @@ Only one type of selector can be specified at a time. When given, ``AT``: Specify a list of indexes. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM AT [ ...] ...) + list(TRANSFORM AT [ ...] ...) ``FOR``: Specify a range with, optionally, an increment used to iterate over the range. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM FOR [] ...) + list(TRANSFORM FOR [] ...) ``REGEX``: Specify a regular expression. Only elements matching the regular expression will be transformed. -.. code-block:: cmake + .. code-block:: cmake - list(TRANSFORM REGEX ...) + list(TRANSFORM REGEX ...) Ordering -- cgit v0.12 From c509f38b7b8c80e0174be75b6f8d5e99343213b7 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sun, 30 Jun 2019 21:15:35 +1000 Subject: Help: Add missing xref for CMAKE_EXECUTE_PROCESS_COMMAND_ECHO --- Help/command/execute_process.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index b11d1ac..14f879d 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -81,6 +81,8 @@ Options: ``COMMAND_ECHO `` The command being run will be echo'ed to ```` with ```` 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 `` On Windows, the encoding that is used to decode output from the process. -- cgit v0.12 From ddc7ea46961da54fe00d13f20e6192540f801949 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Tue, 2 Jul 2019 23:14:31 +1000 Subject: Help: Clarify how to provide multiple targets with cmake --target --- Help/manual/cmake.1.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index dccf797..e91f060 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -290,7 +290,8 @@ following options: value of ``1`` can be used to limit to a single job. ``--target ..., -t ...`` - Build ```` instead of default targets. May be specified multiple times. + Build ```` instead of the default target. Multiple targets may be + given, separated by spaces. ``--config `` For multi-configuration tools, choose configuration ````. -- cgit v0.12 From d5b722bbbd684477e8b8a979ba62a2f1b45a720c Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Wed, 3 Jul 2019 23:37:54 +1000 Subject: Help: Remove mention of CMAKE_INSTALL_DO_STRIP It isn't yet clear whether we want to make this part of the documented API for the install script. Remove it from the docs before it appears in an official release for now. Relates: #18997 --- Help/manual/cmake.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index e91f060..ff099dd 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -343,7 +343,7 @@ The options are: 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. -- cgit v0.12