Commit Graph

1362 Commits

Author SHA1 Message Date
Brad King 5dde65ac5b Help: De-duplicate manual/(cmake|ccmake).1.rst build options
Move common build options out of cmake and ccmake manuals into an
OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 16:24:51 -04:00
Brad King ae944d176e Help: Organize manual/*.1.rst sections
Add "Synopsis", "Description", and "See Also" manual page section
headers.  These are typical of .1 man section pages.  Also de-duplicate
the See Also section links using a separate LINKS.txt file included from
each manual.
2013-10-16 16:23:32 -04:00
Brad King 4f7d708ac7 Help: Drop leftover conversion content from manual/*.1.rst
Some text in these manuals is left from the old full help transition
text generated by the automatic conversion process.  Drop it.
2013-10-16 12:50:41 -04:00
Vadim Zhukov c6f339ceb8 Add FindBacktrace.cmake module.
It designed to search for implementation of backtrace(3) routine.
Currently it is used in OpenBSD Ports for building Clementine
music player.

A lot of input from brad.king@ and neundorf@.
2013-10-16 10:53:01 -04:00
Brad King e7ca48f226 Help: Factor out cmake-generator-expressions manual page
Generator expressions are supported in many places and are a distinct
concept worthy of their own manual page.  The old builtin documentation
was previously represented by preprocessor macros to generate it into
each place that supports them.  Factor out the duplicate content into a
dedicated cmake-generator-expressions manual page and reference it from
each original location.
2013-10-16 09:22:38 -04:00
Brad King 97e8650d7b Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
The COMPILE_DEFINITIONS escaping disclaimer was represented in builtin
documentation using a preprocessor macro.  Factor the duplicate content
out into a separate .txt file and include it in each document with the
reStructuredText include directive.
2013-10-16 09:22:38 -04:00
Brad King 898216137a Help: Factor out find_* command duplication
These documents were represented in the builtin documentation using a
common starting point with placeholders substituted by each command.
Convert them back to this approach using the reStructuredText include
directive and substitutions to avoid duplication.
2013-10-16 09:22:38 -04:00
Brad King 30b21860ad Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
Portions of these documents contain duplicate content generated from
preprocessor macros in the original builtin documentation source.
Factor the common parts out into .txt files using reStructuredText
include directives and substitutions to avoid duplication.
2013-10-16 09:22:38 -04:00
Brad King 441f2808ec Help: Fix reStructuredText syntax in auto-generated documents 2013-10-15 14:12:49 -04:00
Brad King 6ceb651155 Help: Add index.rst top-level document
Add a top-level document holding the Sphinx root toctree.  List all
reference manuals from Help/manual/*.rst and the Sphinx-generated
general index (genindex) and search pages.
2013-10-15 14:12:49 -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
Kitware Robot 81759c77af Add Help/generator/*.rst for Windows- and OS X-only generators
Run "cmake --help-full cmake.1.rst" by hand on Windows and OS X.
Copy the generator/*.rst documents for generators unique to those
platforms into Help/generator.
2013-10-15 11:17:08 -04:00