summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-12-09 13:40:33 (GMT)
committerBrad King <brad.king@kitware.com>2014-12-09 13:40:33 (GMT)
commitd425c1104588e82619a461b77e310b15b6dec1d0 (patch)
treefa392a2ecb7dc217843855cf193778f8930ea87b /Help
parent433c6d4689ca86f1a8d8d966be0204e98f95b968 (diff)
downloadCMake-d425c1104588e82619a461b77e310b15b6dec1d0.zip
CMake-d425c1104588e82619a461b77e310b15b6dec1d0.tar.gz
CMake-d425c1104588e82619a461b77e310b15b6dec1d0.tar.bz2
Help: Drop FeatureSummary example in cmake-developer.7
The use of FeatureSummary inside a find module is not a convention yet used by upstream CMake modules. Drop the example from the documentation about how to write find modules. If in the future we add use of FeatureSummary to many of the upstream find modules then this example can be restored as part of establishing the convention.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-developer.7.rst11
1 files changed, 0 insertions, 11 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst
index 0884a59..097d8fc 100644
--- a/Help/manual/cmake-developer.7.rst
+++ b/Help/manual/cmake-developer.7.rst
@@ -1115,17 +1115,6 @@ not any of its dependencies. Instead, those dependencies should also be
targets, and CMake should be told that they are dependencies of this target.
CMake will then combine all the necessary information automatically.
-We should also provide some information about the package, such as where to
-download it.
-
-.. code-block:: cmake
-
- include(FeatureSummary)
- set_package_properties(Foo PROPERTIES
- URL "http://www.foo.example.com/"
- DESCRIPTION "A library for doing useful things"
- )
-
Most of the cache variables should be hidden in the ``ccmake`` interface unless
the user explicitly asks to edit them.