summaryrefslogtreecommitdiff
path: root/Modules/FeatureSummary.cmake
diff options
context:
space:
mode:
authorAlex Neundorf <neundorf@kde.org>2010-08-24 23:08:41 +0200
committerAlex Neundorf <neundorf@kde.org>2010-08-24 23:08:41 +0200
commitb35352464c9eee0f4b07fef23a7920225e1928e0 (patch)
tree73f57ae26c2aaddd179c0215aac2e59317936f8a /Modules/FeatureSummary.cmake
parent6fc88b26b6c7b9733714ae99a4cc20680ef8ba36 (diff)
downloadcmake-b35352464c9eee0f4b07fef23a7920225e1928e0.tar.gz
Improve wording of the documentation.
Alex
Diffstat (limited to 'Modules/FeatureSummary.cmake')
-rw-r--r--Modules/FeatureSummary.cmake12
1 files changed, 7 insertions, 5 deletions
diff --git a/Modules/FeatureSummary.cmake b/Modules/FeatureSummary.cmake
index f578649a69..065c31160f 100644
--- a/Modules/FeatureSummary.cmake
+++ b/Modules/FeatureSummary.cmake
@@ -15,8 +15,8 @@
#
# The WHAT option is the only mandatory option. Here you specify what information
# will be printed:
-# ENABLED_FEATURES: the list of all packages which have been found, excluding the QUIET ones
-# DISABLED_FEATURES: the list of all packages which have not been found, excluding the QUIET ones
+# ENABLED_FEATURES: the list of all features and packages which have been found, excluding the QUIET ones
+# DISABLED_FEATURES: the list of all features and packages which have not been found, excluding the QUIET ones
# PACKAGES_FOUND: the list of all packages which have been found, including the QUIET ones
# PACKAGES_NOT_FOUND: the list of all packages which have not been found, including the QUIET ones
# ALL: this will give all packages which have or have not been found
@@ -49,15 +49,17 @@
# which uses the module after the FIND_PACKAGE() call.
# The features for which information can be set are added automatically by the
# find_package() command. If you want to add additional features, you can add
-# them by appending them to the global ENABLED_FEATURES, DISABLED_FEATURES,
-# PACKAGES_FOUND and PACKAGES_NOT_FOUND properties.
+# them by appending them to the global ENABLED_FEATURES or DISABLED_FEATURES properties.
#
-# Example:
+# Example for setting the info for a package:
+# FIND_PACKAGE(LibXml2)
# SET_FEATURE_INFO(LibXml2 "XML processing library." "http://xmlsoft.org/")
#
+#
# PRINT_ENABLED_FEATURES()
# Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:")
#
+#
# PRINT_DISABLED_FEATURES()
# Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:")