c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
68 lines
2.0 KiB
ReStructuredText
68 lines
2.0 KiB
ReStructuredText
source_group
|
|
------------
|
|
|
|
Define a grouping for source files in IDE project generation.
|
|
There are two different signatures to create source groups.
|
|
|
|
.. code-block:: cmake
|
|
|
|
source_group(<name> [FILES <src>...] [REGULAR_EXPRESSION <regex>])
|
|
source_group(TREE <root> [PREFIX <prefix>] [FILES <src>...])
|
|
|
|
Defines a group into which sources will be placed in project files.
|
|
This is intended to set up file tabs in Visual Studio.
|
|
The options are:
|
|
|
|
``TREE``
|
|
.. versionadded:: 3.8
|
|
|
|
CMake will automatically detect, from ``<src>`` files paths, source groups
|
|
it needs to create, to keep structure of source groups analogically to the
|
|
actual files and directories structure in the project. Paths of ``<src>``
|
|
files will be cut to be relative to ``<root>``.
|
|
|
|
``PREFIX``
|
|
.. versionadded:: 3.8
|
|
|
|
Source group and files located directly in ``<root>`` path, will be placed
|
|
in ``<prefix>`` source groups.
|
|
|
|
``FILES``
|
|
Any source file specified explicitly will be placed in group
|
|
``<name>``. Relative paths are interpreted with respect to the
|
|
current source directory.
|
|
|
|
``REGULAR_EXPRESSION``
|
|
Any source file whose name matches the regular expression will
|
|
be placed in group ``<name>``.
|
|
|
|
If a source file matches multiple groups, the *last* group that
|
|
explicitly lists the file with ``FILES`` will be favored, if any.
|
|
If no group explicitly lists the file, the *last* group whose
|
|
regular expression matches the file will be favored.
|
|
|
|
The ``<name>`` of the group and ``<prefix>`` argument may contain forward
|
|
slashes or backslashes to specify subgroups. Backslashes need to be escaped
|
|
appropriately:
|
|
|
|
.. code-block:: cmake
|
|
|
|
source_group(base/subdir ...)
|
|
source_group(outer\\inner ...)
|
|
source_group(TREE <root> PREFIX sources\\inc ...)
|
|
|
|
.. versionadded:: 3.18
|
|
Allow using forward slashes (``/``) to specify subgroups.
|
|
|
|
For backwards compatibility, the short-hand signature
|
|
|
|
.. code-block:: cmake
|
|
|
|
source_group(<name> <regex>)
|
|
|
|
is equivalent to
|
|
|
|
.. code-block:: cmake
|
|
|
|
source_group(<name> REGULAR_EXPRESSION <regex>)
|