From 8235effe482308b640e91ca44f0ffe21546522d0 Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 9 Dec 2014 08:35:46 -0500 Subject: [PATCH 1/2] 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. --- Help/manual/cmake-developer.7.rst | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 3b9b92131..682ce47ba 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -1093,17 +1093,6 @@ The ``RELEASE`` variant should be listed first in the property so that that variant is chosen if the user uses a configuration which is not an exact match for any listed ``IMPORTED_CONFIGURATIONS``. -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. From d425c1104588e82619a461b77e310b15b6dec1d0 Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 9 Dec 2014 08:40:33 -0500 Subject: [PATCH 2/2] 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. --- Help/manual/cmake-developer.7.rst | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 0884a599f..097d8fc6f 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.