Commit Graph

3 Commits

Author SHA1 Message Date
Craig Scott
12deb051b3 Help: Use correct CPack generator names
CPack generator names were not used consistently
throughout the documentation, resulting in ambiguity
about what the correct name was for use with the
`cpack -G` option. With the changes in this commit, the
cpack-generators(7) page of the manual now shows the
correct names and other help pages no longer use
inconsistent or incorrect names.
2018-11-06 16:42:38 +11:00
Kyle Edwards
2a2829cc75 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.
2018-06-21 11:00:25 -04:00
Kitware Robot
f051814ed0 Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.
2013-10-15 14:12:03 -04:00