summaryrefslogtreecommitdiff
path: root/Help/index.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2018-06-15 13:20:45 -0400
committerKyle Edwards <kyle.edwards@kitware.com>2018-06-21 11:00:25 -0400
commit2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a (patch)
treedd2d8494ccbec274bb06d698f975cf7563d722e9 /Help/index.rst
parentbe6267808a6b02c4125054d2fbcb81651b63e9aa (diff)
downloadcmake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.tar.gz
Help: Add new section for CPack generators
The documentation for CPack generators previously lived in their respective internal CMake modules. This setup was misleading, because it implied that you should include the modules in your own code, which is not the case. Moving the documentation into a separate section does a better job of hiding the internal modules, which are just an implementation detail. The generator documentation has also been modified to remove any references to the module name. The CPackIFW module is a special exception: since it has user-facing macros, the documentation for these macros has been kept in the module page, while all other documentation related to the IFW generator has been moved into the new section. To make it easier to find the new documentation, the old help pages for the CPack*.cmake modules have not been deleted, but have been replaced with a link to their respective help page in the new documentation section.
Diffstat (limited to 'Help/index.rst')
-rw-r--r--Help/index.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Help/index.rst b/Help/index.rst
index fa5273c0c3..fe1b73c269 100644
--- a/Help/index.rst
+++ b/Help/index.rst
@@ -41,6 +41,7 @@ Reference Manuals
/manual/cmake-server.7
/manual/cmake-toolchains.7
/manual/cmake-variables.7
+ /manual/cpack-generators.7
.. only:: html or text