diff options
author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-07 20:30:30 (GMT) |
---|---|---|
committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-09 15:51:57 (GMT) |
commit | c705279bae45c85b689febd66d5437d9ec05c9b9 (patch) | |
tree | f64bca14f17a902a96d67a30357df3d1e6c745eb /Help/command/project.rst | |
parent | 63a1917d098922b59bbba8fdeb42519363d5ba0d (diff) | |
download | CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.zip CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.gz CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.bz2 |
Help: Add `.. versionadded` directives to commands documentation
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
Diffstat (limited to 'Help/command/project.rst')
-rw-r--r-- | Help/command/project.rst | 27 |
1 files changed, 25 insertions, 2 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst index c325050..d3454cc 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -55,10 +55,14 @@ The options are: * :variable:`PROJECT_VERSION_TWEAK`, :variable:`<PROJECT-NAME>_VERSION_TWEAK`. - When the ``project()`` command is called from the top-level ``CMakeLists.txt``, - then the version is also stored in the variable :variable:`CMAKE_PROJECT_VERSION`. + .. versionadded:: 3.12 + When the ``project()`` command is called from the top-level + ``CMakeLists.txt``, then the version is also stored in the variable + :variable:`CMAKE_PROJECT_VERSION`. ``DESCRIPTION <project-description-string>`` + .. versionadded:: 3.9 + Optional. Sets the variables @@ -71,7 +75,12 @@ The options are: When the ``project()`` command is called from the top-level ``CMakeLists.txt``, then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`. + .. versionadded:: 3.12 + Added ``<PROJECT-NAME>_DESCRIPTION`` variable. + ``HOMEPAGE_URL <url-string>`` + .. versionadded:: 3.12 + Optional. Sets the variables @@ -93,6 +102,15 @@ The options are: Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages, to skip enabling any languages. + .. versionadded:: 3.8 + Added ``CUDA`` support. + + .. versionadded:: 3.16 + Added ``OBJC`` and ``OBJCXX`` support. + + .. versionadded:: 3.18 + Added ``ISPC`` support. + If enabling ``ASM``, list it last so that CMake can check whether compilers for other languages like ``C`` work for assembly too. @@ -102,6 +120,8 @@ options are intended for use as default values in package metadata and documenta Code Injection ^^^^^^^^^^^^^^ +.. versionadded:: 3.15 + If the :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` or :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE` variables are set, the files they point to will be included as the first step of the @@ -115,6 +135,9 @@ they point to will be included as the last step of the ``project()`` command. If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`. +.. versionadded:: 3.17 + Added ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable. + Usage ^^^^^ |