Commit Graph

36 Commits

Author SHA1 Message Date
Brad King 96afb12087 Convert CMake to OSI-approved BSD License
This converts the CMake license to a pure 3-clause OSI-approved BSD
License.  We drop the previous license clause requiring modified
versions to be plainly marked.  We also update the CMake copyright to
cover the full development time range.
2009-09-28 11:43:28 -04:00
Brad King 5a82a0b108 ENH: Improve generated documentation formatting
Applying patch provided in issue #7797.

Fixes to man-pages:
  - Character '-' must be espaced as '\-'
  - Surround preformatted text with '.nf' and '.fi' to adjust filling
  - Give every page a NAME section for indexing by mandb
  - Pass the man page filename without extension to .TH in its header

Also added a title to the HTML header.
2008-10-10 11:23:35 -04:00
Bill Hoffman d632b96841 BUG: fix 6647 arguments after -E should not be parsed by CMake 2008-08-19 15:42:48 -04:00
Ken Martin d47a5951ed ENH: add --help-policies and --help-policy command line options 2008-03-04 09:16:33 -05:00
Alexander Neundorf 969ea3f449 ENH: add support for creating the documentation in docbook format
(http://www.oasis-open.org/docbook/xml/4.2/), which users can then convert
to other formats.
Tested with meinproc from KDE, which generates HTML pages which look good.

Alex
2008-02-19 14:33:43 -05:00
Ken Martin c2f0aac146 ENH: some more cleanup, fixes, and patch for HTML output 2007-10-24 11:36:47 -04:00
Ken Martin 44cce51a1a COMP: fix some warnings and add some doc strings back in 2007-10-22 15:33:19 -04:00
Ken Martin 6cdf032505 ENH: change to make the documentation class more generic, about halfway there, also provides secitons for Variables now 2007-10-22 12:49:09 -04:00
Alexander Neundorf 31881265c7 ENH: add new help option --help-custom-modules, which generates
documentation for all modules found in CMAKE_MODULE_PATH, which currently
has to be specified via -D, this can later on be improved e.g. by reading a
special (to-be-created) file like CMakeFiles/ModulePath.cmake in the build
tree so that running cmake help in the build tree of a project will always
give you the current module path. (This could actually also help IDEs which
would like to support cmake for projects...)

Alex
2007-09-19 13:14:25 -04:00
Alexander Neundorf c5f249bdbd STYLE: move the code for the different formats of the generated help into
their own classes, making cmDocumentation smaller and also making it easier
to eventually add another format

Alex
2007-09-19 09:05:28 -04:00
Alexander Neundorf 9f16292b6a STYLE: sort the property documentation into
global/directory/target/test/sourcefile and variable sections

Alex
2007-07-11 15:53:58 -04:00
Alexander Neundorf ad2fe23f6f COMP: fix compile on HP-UX with aCC, reusing the same identifier for a
variable as for the enum type doesn't work here

Alex
2007-07-03 08:26:32 -04:00
Alexander Neundorf 611f86b7f6 COMP: fix build with msvc 6, the enums are now part of a class which is
already completely parsed

Alex
2007-07-02 11:24:44 -04:00
Alexander Neundorf 151d55557e ENH: generate separate documentation for the commands, compatiblity
commands, modules and properties as html, text and man pages.
The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules,
so they are easy to type.

Alex
2007-06-28 15:04:28 -04:00
Alexander Neundorf c95dc91237 ENH:
-in the full documentation there is now an extra section for
compatibility commands, so users see which commands they shouldn't use
-cmake -h <command> now also works with lower case commands
--help-fullm --help-command, --help-module and --help-property now determine
the output format from the extension of the given filename

Let me know if there are some things I overlooked.

Alex
2007-06-28 11:00:57 -04:00
Alexander Neundorf 1d9889c5d3 ENH: put compatibility commands in extra section and prepare for creating
separate man pages for properties, modules, commands and compatibility
commands

Alex
2007-06-22 08:44:51 -04:00
Brad King 1feb4a09b0 COMP: Fix void return failure. 2007-02-02 14:13:51 -05:00
Brad King f8b898fa6d STYLE: Fixed line length and this-> convention violations from yesterday's patch. 2007-02-02 09:11:41 -05:00
Brad King 58bf0dbac1 ENH: Patch from Alex to improve implementation and prepare for splitting the man page into more sections. 2007-02-01 10:38:42 -05:00
Brad King 1e566707da COMP: Patch from Alex for const correctness. 2007-01-22 10:52:24 -05:00
Ken Martin 27379d7b08 ENH: make properties a bit more formal with documentation and chaining 2006-12-07 09:45:32 -05:00
Bill Hoffman 96a46bdb44 ENH: search for help modules in the correct place for install and source tree builds 2006-04-13 23:15:48 -04:00
Bill Hoffman b7fa820118 ENH: add documentation support for modules 2005-12-14 13:51:08 -05:00
Brad King 0c92cfb8c4 ENH: Renamed --help-list-commands to --help-command-list and split --help [command] into separate --help and --help-command cmd options. 2004-04-14 14:25:43 -04:00
Brad King 8020279dd6 ENH: Added --help-list-commands option. 2004-04-14 13:40:24 -04:00
Brad King b78888fe38 ENH: Added configuration of name of executable in man page header and version banner. 2003-08-06 14:49:52 -04:00
Brad King c4794319c7 ENH: Added support to --help to print help for a single command. 2003-08-05 18:10:45 -04:00
Brad King fde552ea6e ENH: CheckOptions now takes const argv. 2003-07-23 17:27:34 -04:00
Brad King 7c2b4e3a02 ENH: Added SEE ALSO section to generated man page. Minor formatting improvements for generated text-only documentation. 2003-07-10 23:15:45 -04:00
Brad King 1cecf7b5aa ENH: Added support to write multiple help options with one command line. Output files can now also be specified for the help options. 2003-07-07 22:44:18 -04:00
Brad King e5ed57ec18 ENH: Registered global generators are now kept in a table in the cmake instance. Added support for documentation with a Generators section. 2003-07-07 21:52:10 -04:00
Brad King 5e18bec8f7 ENH: Re-implemented document generation class to be more organized and more robust. 2003-02-18 20:42:02 -05:00
Brad King 07cdd0e60c ENH: Added header before list of commands in generated docs. Made options more intuitive. 2003-02-17 09:42:13 -05:00
Brad King 0005e70c05 ENH: Further improved formatting. HTML/man/help now all have a consistent appearance. 2003-02-14 13:28:46 -05:00
Brad King 2c7a05edd2 ENH: Improved formatting of documentation. 2003-02-14 13:06:37 -05:00
Brad King 1f55680332 ENH: Added cmDocumentation class to generate various forms of documentation. Each executable will be able to generate its own documentation. 2003-02-14 10:53:37 -05:00