Help: Prefer spelling out 'semicolon-separated list'

Fixes: #27663
This commit is contained in:
Tyler Yankee
2026-03-03 09:27:44 -05:00
parent d3d2ad487d
commit 01e306dbde
5 changed files with 17 additions and 17 deletions
+5 -5
View File
@@ -3,11 +3,11 @@ ADDITIONAL_CLEAN_FILES
.. versionadded:: 3.15
A :ref:`;-list <CMake Language Lists>` of files or directories that will be
removed as a part of the global ``clean`` target. It is useful for
specifying generated files or directories that are used by multiple targets
or by CMake itself, or that are generated in ways which cannot be captured as
outputs or byproducts of custom commands.
A :ref:`semicolon-separated list <CMake Language Lists>` of files or
directories that will be removed as a part of the global ``clean`` target.
It is useful for specifying generated files or directories that are used by
multiple targets or by CMake itself, or that are generated in ways which cannot
be captured as outputs or byproducts of custom commands.
If an additional clean file is specific to a single target only, then the
:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better
@@ -7,8 +7,8 @@ ADDITIONAL_MAKE_CLEAN_FILES
Additional files to remove during the clean stage.
A :ref:`;-list <CMake Language Lists>` of files that will be removed as a
part of the ``make clean`` target.
A :ref:`semicolon-separated list <CMake Language Lists>` of files that will be
removed as a part of the ``make clean`` target.
Arguments to ``ADDITIONAL_MAKE_CLEAN_FILES`` may use
:manual:`generator expressions <cmake-generator-expressions(7)>`.
+5 -5
View File
@@ -3,11 +3,11 @@ ADDITIONAL_CLEAN_FILES
.. versionadded:: 3.15
A :ref:`;-list <CMake Language Lists>` of files or directories that will be
removed as a part of the global ``clean`` target. It can be used to specify
files and directories that are generated as part of building the target or
that are directly associated with the target in some way (e.g. created as a
result of running the target).
A :ref:`semicolon-separated list <CMake Language Lists>` of files or
directories that will be removed as a part of the global ``clean`` target.
It can be used to specify files and directories that are generated as part of
building the target or that are directly associated with the target in some way
(e.g. created as a result of running the target).
For custom targets, if such files can be captured as outputs or byproducts
instead, then that should be preferred over adding them to this property.
+3 -3
View File
@@ -18,9 +18,9 @@ which generates ``moc`` and ``uic`` files.
As this :ref:`<ORIGIN>_autogen <<ORIGIN>_autogen>` target is created
at generate-time, it is not possible to define dependencies of it using e.g.
:command:`add_dependencies`. Instead the ``AUTOGEN_TARGET_DEPENDS`` target
property can be set to a :ref:`;-list <CMake Language Lists>` of additional
dependencies for the :ref:`<ORIGIN>_autogen <<ORIGIN>_autogen>` target.
Dependencies can be target names or file names.
property can be set to a :ref:`semicolon-separated list <CMake Language Lists>`
of additional dependencies for the :ref:`<ORIGIN>_autogen <<ORIGIN>_autogen>`
target. Dependencies can be target names or file names.
In total, the dependencies of the :ref:`<ORIGIN>_autogen <<ORIGIN>_autogen>`
target are composed from
+2 -2
View File
@@ -145,8 +145,8 @@ same as the Google Test name (i.e. ``suite.testcase``); see also
``exe``
The path to the test executable or the name of a CMake target.
``args``
A ;-list of extra arguments to be passed to executable. The entire
list must be passed as a single argument. Enclose it in quotes,
A semicolon-separated list of extra arguments to be passed to executable.
The entire list must be passed as a single argument. Enclose it in quotes,
or pass ``""`` for no arguments.
``files...``
A list of source files to search for tests and test fixtures.