diff options
author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-12 13:40:33 +0500 |
---|---|---|
committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-12-02 21:00:30 +0500 |
commit | 8fea95319bcaac741faf93bd66b3a1838b56a418 (patch) | |
tree | 2bc107ce0cc4844e79f0baf93a394d93c27edaa8 /Modules/FeatureSummary.cmake | |
parent | 8634561dcae9f5ff5128eaf7c83aa71170992ec2 (diff) | |
download | cmake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.gz |
Help: Add `.. versionadded` directives to module docs
Issue: #19715
Diffstat (limited to 'Modules/FeatureSummary.cmake')
-rw-r--r-- | Modules/FeatureSummary.cmake | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/Modules/FeatureSummary.cmake b/Modules/FeatureSummary.cmake index 4a3e83af31..77c66d14af 100644 --- a/Modules/FeatureSummary.cmake +++ b/Modules/FeatureSummary.cmake @@ -66,6 +66,8 @@ The default value for this global property is ``OPTIONAL``. .. variable:: FeatureSummary_<TYPE>_DESCRIPTION +.. versionadded:: 3.9 + The global property :variable:`FeatureSummary_<TYPE>_DESCRIPTION` can be defined for each type to replace the type name with the specified string whenever the package type is used in an output string. @@ -242,12 +244,13 @@ endfunction() ``<TYPE>_PACKAGES_NOT_FOUND`` only those packages which have not been found which have the type <TYPE> - With the exception of the ``ALL`` value, these values can be combined - in order to customize the output. For example: + .. versionchanged:: 3.1 + With the exception of the ``ALL`` value, these values can be combined + in order to customize the output. For example: - .. code-block:: cmake + .. code-block:: cmake - feature_summary(WHAT ENABLED_FEATURES DISABLED_FEATURES) + feature_summary(WHAT ENABLED_FEATURES DISABLED_FEATURES) If a ``FILENAME`` is given, the information is printed into this file. If ``APPEND`` is used, it is appended to this file, otherwise the file is @@ -268,14 +271,18 @@ endfunction() The default value for the :variable:`FeatureSummary_REQUIRED_PKG_TYPES` global property is ``REQUIRED``. + .. versionadded:: 3.9 + The ``DEFAULT_DESCRIPTION`` option. + The :variable:`FeatureSummary_DEFAULT_PKG_TYPE` global property can be modified to change the default package type assigned when not explicitly assigned by the user. - If the ``QUIET_ON_EMPTY`` option is used, if only one type of package was - requested, and no packages belonging to that category were found, then no - output (including the ``DESCRIPTION``) is printed or added to the ``VAR`` - variable. + .. versionadded:: 3.8 + If the ``QUIET_ON_EMPTY`` option is used, if only one type of package was + requested, and no packages belonging to that category were found, then no + output (including the ``DESCRIPTION``) is printed or added to the ``VAR`` + variable. Example 1, append everything to a file: @@ -617,6 +624,9 @@ endfunction() be displayed using ``feature_summary()`` for ``ENABLED_FEATURES`` and ``DISABLED_FEATURES`` respectively. + .. versionchanged:: 3.8 + ``<enabled>`` can be a list of conditions. + Example for setting the info for a feature: .. code-block:: cmake |