diff options
| author | Brad King <brad.king@kitware.com> | 2014-12-09 08:40:33 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-12-09 08:40:33 -0500 |
| commit | d425c1104588e82619a461b77e310b15b6dec1d0 (patch) | |
| tree | fa392a2ecb7dc217843855cf193778f8930ea87b | |
| parent | 433c6d4689ca86f1a8d8d966be0204e98f95b968 (diff) | |
| download | cmake-d425c1104588e82619a461b77e310b15b6dec1d0.tar.gz | |
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.
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 0884a599fe..097d8fc6f0 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. |