kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
23,033 Commits 1 Branch 14 Tags 53 MiB
Commit Graph

16 Commits

Author SHA1 Message Date
Kitware Robot 3442f2bcc4 Help: Format manual/*.1.rst options as definition lists 
Convert the command-line option documentation formatting from bullet
lists to definition lists.
 2013-11-14 10:05:32 -05:00
Brad King 93fe461e6c Merge topic 'remove-cmake-i-wizard' 
0fa9aea Help: Drop mention of cmake -i wizard mode
 2013-11-05 08:17:06 -05:00
Brad King 0fa9aea293 Help: Drop mention of cmake -i wizard mode 
The parent commit removed support for this mode, so do not mention
it in the documentation.
 2013-11-04 11:16:22 -05:00
Brad King d1e8a0240b Help: Refine manual/*.1.rst usage summaries 
Use a parsed-literal block to list possible command-line signatures.
Add an "Options" section header before the list of options.
 2013-11-04 11:06:14 -05:00
Brad King f88332f5b7 Help: Glob manual/*.rst in Sphinx configuration 
Add the man page description line as explicit markup at the top of each
Help/manual/*.rst file and scan it from conf.py to automatically
generate the man_pages Sphinx configuration value.  This reduces the
number of places that need to be changed when a new manual is added.
 2013-10-30 09:58:25 -04:00
Brad King 61de941ad7 Merge topic 'cmake--build-pipes' 
bcd5de7 cmake: Always pass through stdout/stderr in --build mode
 2013-10-22 09:07:23 -04:00
Brad King 6384f1683a Merge topic 'remove-cmake-i-wizard' 
a8226e9 cmake: Drop support for "-i" wizard mode
 2013-10-22 09:07:14 -04:00
Brad King c076476d7d cmake: Drop "cmake -E comspec" Win9x helper 
Since we dropped Win9x support there is no need for this helper.
 2013-10-19 07:19:49 -04:00
Brad King bcd5de775a cmake: Always pass through stdout/stderr in --build mode 
Enable the --use-stderr behavior by default and ignore the old option.
Passing through the pipes allows color terminal output and other things
to work as if one ran the native build command directly.
 2013-10-18 13:45:27 -04:00
Brad King a8226e91d7 cmake: Drop support for "-i" wizard mode 
Tell users to pass cache values with the -D option on the command line
or use cmake-gui or ccmake.
 2013-10-18 13:32:39 -04:00
Brad King 9b212ad01a Make --help-* options available from all command-line tools 
Make the standard --help-* options available from all command-line
tools.  Drop options that are no longer supported:

  --copyright, --help-full, --help-html, --help-man,
  --help-compatcommands, --help-custom-modules

De-duplicate Help/manual/*.1.rst help options by using an
OPTIONS_HELP.txt file included from each manual.
 2013-10-16 16:24:51 -04:00
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
Brad King 441f2808ec Help: Fix reStructuredText syntax in auto-generated documents 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