FeatureSummary: Convert docs to a bracket comment
Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
This commit is contained in:
Brad King
parent
7c92c84302
commit
5d17e99580
|
|
@ -1,268 +1,269 @@
|
||||||
#.rst:
|
#[=======================================================================[.rst:
|
||||||
# FeatureSummary
|
FeatureSummary
|
||||||
# --------------
|
--------------
|
||||||
#
|
|
||||||
# Macros for generating a summary of enabled/disabled features
|
Macros for generating a summary of enabled/disabled features
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# This module provides the macros feature_summary(),
|
This module provides the macros feature_summary(),
|
||||||
# set_package_properties() and add_feature_info(). For compatibility it
|
set_package_properties() and add_feature_info(). For compatibility it
|
||||||
# also still provides set_package_info(), set_feature_info(),
|
also still provides set_package_info(), set_feature_info(),
|
||||||
# print_enabled_features() and print_disabled_features().
|
print_enabled_features() and print_disabled_features().
|
||||||
#
|
|
||||||
# These macros can be used to generate a summary of enabled and disabled
|
These macros can be used to generate a summary of enabled and disabled
|
||||||
# packages and/or feature for a build tree:
|
packages and/or feature for a build tree:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# -- The following OPTIONAL packages have been found:
|
-- The following OPTIONAL packages have been found:
|
||||||
# LibXml2 (required version >= 2.4), XML processing lib, <http://xmlsoft.org>
|
LibXml2 (required version >= 2.4), XML processing lib, <http://xmlsoft.org>
|
||||||
# * Enables HTML-import in MyWordProcessor
|
* Enables HTML-import in MyWordProcessor
|
||||||
# * Enables odt-export in MyWordProcessor
|
* Enables odt-export in MyWordProcessor
|
||||||
# PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
|
PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
|
||||||
# * Enables saving screenshots
|
* Enables saving screenshots
|
||||||
# -- The following OPTIONAL packages have not been found:
|
-- The following OPTIONAL packages have not been found:
|
||||||
# Lua51 , The Lua scripting language. , <http://www.lua.org>
|
Lua51 , The Lua scripting language. , <http://www.lua.org>
|
||||||
# * Enables macros in MyWordProcessor
|
* Enables macros in MyWordProcessor
|
||||||
# Foo , Foo provides cool stuff.
|
Foo , Foo provides cool stuff.
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# FEATURE_SUMMARY( [FILENAME <file>]
|
FEATURE_SUMMARY( [FILENAME <file>]
|
||||||
# [APPEND]
|
[APPEND]
|
||||||
# [VAR <variable_name>]
|
[VAR <variable_name>]
|
||||||
# [INCLUDE_QUIET_PACKAGES]
|
[INCLUDE_QUIET_PACKAGES]
|
||||||
# [FATAL_ON_MISSING_REQUIRED_PACKAGES]
|
[FATAL_ON_MISSING_REQUIRED_PACKAGES]
|
||||||
# [DESCRIPTION "Found packages:"]
|
[DESCRIPTION "Found packages:"]
|
||||||
# WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND
|
WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND
|
||||||
# | ENABLED_FEATURES | DISABLED_FEATURES)
|
| ENABLED_FEATURES | DISABLED_FEATURES)
|
||||||
# )
|
)
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# The FEATURE_SUMMARY() macro can be used to print information about
|
The FEATURE_SUMMARY() macro can be used to print information about
|
||||||
# enabled or disabled packages or features of a project. By default,
|
enabled or disabled packages or features of a project. By default,
|
||||||
# only the names of the features/packages will be printed and their
|
only the names of the features/packages will be printed and their
|
||||||
# required version when one was specified. Use SET_PACKAGE_PROPERTIES()
|
required version when one was specified. Use SET_PACKAGE_PROPERTIES()
|
||||||
# to add more useful information, like e.g. a download URL for the
|
to add more useful information, like e.g. a download URL for the
|
||||||
# respective package or their purpose in the project.
|
respective package or their purpose in the project.
|
||||||
#
|
|
||||||
# The WHAT option is the only mandatory option. Here you specify what
|
The WHAT option is the only mandatory option. Here you specify what
|
||||||
# information will be printed:
|
information will be printed:
|
||||||
#
|
|
||||||
# ``ALL``
|
``ALL``
|
||||||
# print everything
|
print everything
|
||||||
# ``ENABLED_FEATURES``
|
``ENABLED_FEATURES``
|
||||||
# the list of all features which are enabled
|
the list of all features which are enabled
|
||||||
# ``DISABLED_FEATURES``
|
``DISABLED_FEATURES``
|
||||||
# the list of all features which are disabled
|
the list of all features which are disabled
|
||||||
# ``PACKAGES_FOUND``
|
``PACKAGES_FOUND``
|
||||||
# the list of all packages which have been found
|
the list of all packages which have been found
|
||||||
# ``PACKAGES_NOT_FOUND``
|
``PACKAGES_NOT_FOUND``
|
||||||
# the list of all packages which have not been found
|
the list of all packages which have not been found
|
||||||
# ``OPTIONAL_PACKAGES_FOUND``
|
``OPTIONAL_PACKAGES_FOUND``
|
||||||
# only those packages which have been found which have the type OPTIONAL
|
only those packages which have been found which have the type OPTIONAL
|
||||||
# ``OPTIONAL_PACKAGES_NOT_FOUND``
|
``OPTIONAL_PACKAGES_NOT_FOUND``
|
||||||
# only those packages which have not been found which have the type OPTIONAL
|
only those packages which have not been found which have the type OPTIONAL
|
||||||
# ``RECOMMENDED_PACKAGES_FOUND``
|
``RECOMMENDED_PACKAGES_FOUND``
|
||||||
# only those packages which have been found which have the type RECOMMENDED
|
only those packages which have been found which have the type RECOMMENDED
|
||||||
# ``RECOMMENDED_PACKAGES_NOT_FOUND``
|
``RECOMMENDED_PACKAGES_NOT_FOUND``
|
||||||
# only those packages which have not been found which have the type RECOMMENDED
|
only those packages which have not been found which have the type RECOMMENDED
|
||||||
# ``REQUIRED_PACKAGES_FOUND``
|
``REQUIRED_PACKAGES_FOUND``
|
||||||
# only those packages which have been found which have the type REQUIRED
|
only those packages which have been found which have the type REQUIRED
|
||||||
# ``REQUIRED_PACKAGES_NOT_FOUND``
|
``REQUIRED_PACKAGES_NOT_FOUND``
|
||||||
# only those packages which have not been found which have the type REQUIRED
|
only those packages which have not been found which have the type REQUIRED
|
||||||
# ``RUNTIME_PACKAGES_FOUND``
|
``RUNTIME_PACKAGES_FOUND``
|
||||||
# only those packages which have been found which have the type RUNTIME
|
only those packages which have been found which have the type RUNTIME
|
||||||
# ``RUNTIME_PACKAGES_NOT_FOUND``
|
``RUNTIME_PACKAGES_NOT_FOUND``
|
||||||
# only those packages which have not been found which have the type RUNTIME
|
only those packages which have not been found which have the type RUNTIME
|
||||||
#
|
|
||||||
# With the exception of the ``ALL`` value, these values can be combined
|
With the exception of the ``ALL`` value, these values can be combined
|
||||||
# in order to customize the output. For example:
|
in order to customize the output. For example:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# 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
|
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
|
APPEND is used, it is appended to this file, otherwise the file is
|
||||||
# overwritten if it already existed. If the VAR option is used, the
|
overwritten if it already existed. If the VAR option is used, the
|
||||||
# information is "printed" into the specified variable. If FILENAME is
|
information is "printed" into the specified variable. If FILENAME is
|
||||||
# not used, the information is printed to the terminal. Using the
|
not used, the information is printed to the terminal. Using the
|
||||||
# DESCRIPTION option a description or headline can be set which will be
|
DESCRIPTION option a description or headline can be set which will be
|
||||||
# printed above the actual content. If INCLUDE_QUIET_PACKAGES is given,
|
printed above the actual content. If INCLUDE_QUIET_PACKAGES is given,
|
||||||
# packages which have been searched with find_package(... QUIET) will
|
packages which have been searched with find_package(... QUIET) will
|
||||||
# also be listed. By default they are skipped. If
|
also be listed. By default they are skipped. If
|
||||||
# FATAL_ON_MISSING_REQUIRED_PACKAGES is given, CMake will abort if a
|
FATAL_ON_MISSING_REQUIRED_PACKAGES is given, CMake will abort if a
|
||||||
# package which is marked as REQUIRED has not been found.
|
package which is marked as REQUIRED has not been found.
|
||||||
#
|
|
||||||
# Example 1, append everything to a file:
|
Example 1, append everything to a file:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# feature_summary(WHAT ALL
|
feature_summary(WHAT ALL
|
||||||
# FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND)
|
FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND)
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# Example 2, print the enabled features into the variable
|
Example 2, print the enabled features into the variable
|
||||||
# enabledFeaturesText, including QUIET packages:
|
enabledFeaturesText, including QUIET packages:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# feature_summary(WHAT ENABLED_FEATURES
|
feature_summary(WHAT ENABLED_FEATURES
|
||||||
# INCLUDE_QUIET_PACKAGES
|
INCLUDE_QUIET_PACKAGES
|
||||||
# DESCRIPTION "Enabled Features:"
|
DESCRIPTION "Enabled Features:"
|
||||||
# VAR enabledFeaturesText)
|
VAR enabledFeaturesText)
|
||||||
# message(STATUS "${enabledFeaturesText}")
|
message(STATUS "${enabledFeaturesText}")
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# SET_PACKAGE_PROPERTIES(<name> PROPERTIES
|
SET_PACKAGE_PROPERTIES(<name> PROPERTIES
|
||||||
# [ URL <url> ]
|
[ URL <url> ]
|
||||||
# [ DESCRIPTION <description> ]
|
[ DESCRIPTION <description> ]
|
||||||
# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
|
[ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
|
||||||
# [ PURPOSE <purpose> ]
|
[ PURPOSE <purpose> ]
|
||||||
# )
|
)
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# Use this macro to set up information about the named package, which
|
Use this macro to set up information about the named package, which
|
||||||
# can then be displayed via FEATURE_SUMMARY(). This can be done either
|
can then be displayed via FEATURE_SUMMARY(). This can be done either
|
||||||
# directly in the Find-module or in the project which uses the module
|
directly in the Find-module or in the project which uses the module
|
||||||
# after the find_package() call. The features for which information can
|
after the find_package() call. The features for which information can
|
||||||
# be set are added automatically by the find_package() command.
|
be set are added automatically by the find_package() command.
|
||||||
#
|
|
||||||
# URL: this should be the homepage of the package, or something similar.
|
URL: this should be the homepage of the package, or something similar.
|
||||||
# Ideally this is set already directly in the Find-module.
|
Ideally this is set already directly in the Find-module.
|
||||||
#
|
|
||||||
# DESCRIPTION: A short description what that package is, at most one
|
DESCRIPTION: A short description what that package is, at most one
|
||||||
# sentence. Ideally this is set already directly in the Find-module.
|
sentence. Ideally this is set already directly in the Find-module.
|
||||||
#
|
|
||||||
# TYPE: What type of dependency has the using project on that package.
|
TYPE: What type of dependency has the using project on that package.
|
||||||
# Default is OPTIONAL. In this case it is a package which can be used
|
Default is OPTIONAL. In this case it is a package which can be used
|
||||||
# by the project when available at buildtime, but it also work without.
|
by the project when available at buildtime, but it also work without.
|
||||||
# RECOMMENDED is similar to OPTIONAL, i.e. the project will build if
|
RECOMMENDED is similar to OPTIONAL, i.e. the project will build if
|
||||||
# the package is not present, but the functionality of the resulting
|
the package is not present, but the functionality of the resulting
|
||||||
# binaries will be severly limited. If a REQUIRED package is not
|
binaries will be severly limited. If a REQUIRED package is not
|
||||||
# available at buildtime, the project may not even build. This can be
|
available at buildtime, the project may not even build. This can be
|
||||||
# combined with the FATAL_ON_MISSING_REQUIRED_PACKAGES argument for
|
combined with the FATAL_ON_MISSING_REQUIRED_PACKAGES argument for
|
||||||
# feature_summary(). Last, a RUNTIME package is a package which is
|
feature_summary(). Last, a RUNTIME package is a package which is
|
||||||
# actually not used at all during the build, but which is required for
|
actually not used at all during the build, but which is required for
|
||||||
# actually running the resulting binaries. So if such a package is
|
actually running the resulting binaries. So if such a package is
|
||||||
# missing, the project can still be built, but it may not work later on.
|
missing, the project can still be built, but it may not work later on.
|
||||||
# If set_package_properties() is called multiple times for the same
|
If set_package_properties() is called multiple times for the same
|
||||||
# package with different TYPEs, the TYPE is only changed to higher TYPEs
|
package with different TYPEs, the TYPE is only changed to higher TYPEs
|
||||||
# ( RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED ), lower TYPEs are
|
( RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED ), lower TYPEs are
|
||||||
# ignored. The TYPE property is project-specific, so it cannot be set
|
ignored. The TYPE property is project-specific, so it cannot be set
|
||||||
# by the Find-module, but must be set in the project.
|
by the Find-module, but must be set in the project.
|
||||||
#
|
|
||||||
# PURPOSE: This describes which features this package enables in the
|
PURPOSE: This describes which features this package enables in the
|
||||||
# project, i.e. it tells the user what functionality he gets in the
|
project, i.e. it tells the user what functionality he gets in the
|
||||||
# resulting binaries. If set_package_properties() is called multiple
|
resulting binaries. If set_package_properties() is called multiple
|
||||||
# times for a package, all PURPOSE properties are appended to a list of
|
times for a package, all PURPOSE properties are appended to a list of
|
||||||
# purposes of the package in the project. As the TYPE property, also
|
purposes of the package in the project. As the TYPE property, also
|
||||||
# the PURPOSE property is project-specific, so it cannot be set by the
|
the PURPOSE property is project-specific, so it cannot be set by the
|
||||||
# Find-module, but must be set in the project.
|
Find-module, but must be set in the project.
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# Example for setting the info for a package:
|
Example for setting the info for a package:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# find_package(LibXml2)
|
find_package(LibXml2)
|
||||||
# set_package_properties(LibXml2 PROPERTIES
|
set_package_properties(LibXml2 PROPERTIES
|
||||||
# DESCRIPTION "A XML processing library."
|
DESCRIPTION "A XML processing library."
|
||||||
# URL "http://xmlsoft.org/")
|
URL "http://xmlsoft.org/")
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# set_package_properties(LibXml2 PROPERTIES
|
set_package_properties(LibXml2 PROPERTIES
|
||||||
# TYPE RECOMMENDED
|
TYPE RECOMMENDED
|
||||||
# PURPOSE "Enables HTML-import in MyWordProcessor")
|
PURPOSE "Enables HTML-import in MyWordProcessor")
|
||||||
# ...
|
...
|
||||||
# set_package_properties(LibXml2 PROPERTIES
|
set_package_properties(LibXml2 PROPERTIES
|
||||||
# TYPE OPTIONAL
|
TYPE OPTIONAL
|
||||||
# PURPOSE "Enables odt-export in MyWordProcessor")
|
PURPOSE "Enables odt-export in MyWordProcessor")
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# find_package(DBUS)
|
find_package(DBUS)
|
||||||
# set_package_properties(DBUS PROPERTIES
|
set_package_properties(DBUS PROPERTIES
|
||||||
# TYPE RUNTIME
|
TYPE RUNTIME
|
||||||
# PURPOSE "Necessary to disable the screensaver during a presentation" )
|
PURPOSE "Necessary to disable the screensaver during a presentation" )
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# ADD_FEATURE_INFO(<name> <enabled> <description>)
|
ADD_FEATURE_INFO(<name> <enabled> <description>)
|
||||||
#
|
|
||||||
# Use this macro to add information about a feature with the given
|
Use this macro to add information about a feature with the given
|
||||||
# <name>. <enabled> contains whether this feature is enabled or not,
|
<name>. <enabled> contains whether this feature is enabled or not,
|
||||||
# <description> is a text describing the feature. The information can
|
<description> is a text describing the feature. The information can
|
||||||
# be displayed using feature_summary() for ENABLED_FEATURES and
|
be displayed using feature_summary() for ENABLED_FEATURES and
|
||||||
# DISABLED_FEATURES respectively.
|
DISABLED_FEATURES respectively.
|
||||||
#
|
|
||||||
# Example for setting the info for a feature:
|
Example for setting the info for a feature:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# option(WITH_FOO "Help for foo" ON)
|
option(WITH_FOO "Help for foo" ON)
|
||||||
# add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.")
|
add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.")
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# The following macros are provided for compatibility with previous
|
The following macros are provided for compatibility with previous
|
||||||
# CMake versions:
|
CMake versions:
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# SET_PACKAGE_INFO(<name> <description> [<url> [<purpose>] ] )
|
SET_PACKAGE_INFO(<name> <description> [<url> [<purpose>] ] )
|
||||||
#
|
|
||||||
# Use this macro to set up information about the named package, which
|
Use this macro to set up information about the named package, which
|
||||||
# can then be displayed via FEATURE_SUMMARY(). This can be done either
|
can then be displayed via FEATURE_SUMMARY(). This can be done either
|
||||||
# directly in the Find-module or in the project which uses the module
|
directly in the Find-module or in the project which uses the module
|
||||||
# after the find_package() call. The features for which information can
|
after the find_package() call. The features for which information can
|
||||||
# be set are added automatically by the find_package() command.
|
be set are added automatically by the find_package() command.
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# PRINT_ENABLED_FEATURES()
|
PRINT_ENABLED_FEATURES()
|
||||||
#
|
|
||||||
# Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION
|
Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION
|
||||||
# "Enabled features:")
|
"Enabled features:")
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# PRINT_DISABLED_FEATURES()
|
PRINT_DISABLED_FEATURES()
|
||||||
#
|
|
||||||
# Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION
|
Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION
|
||||||
# "Disabled features:")
|
"Disabled features:")
|
||||||
#
|
|
||||||
# ::
|
::
|
||||||
#
|
|
||||||
# SET_FEATURE_INFO(<name> <description> [<url>] )
|
SET_FEATURE_INFO(<name> <description> [<url>] )
|
||||||
#
|
|
||||||
# Does the same as SET_PACKAGE_INFO(<name> <description> <url> )
|
Does the same as SET_PACKAGE_INFO(<name> <description> <url> )
|
||||||
|
#]=======================================================================]
|
||||||
|
|
||||||
#=============================================================================
|
#=============================================================================
|
||||||
# Copyright 2007-2015 Kitware, Inc.
|
# Copyright 2007-2015 Kitware, Inc.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue