3353d84c14
Usage: Document all options printing usage information.
2011-10-23 22:18:14 +02:00
d3d7e45df2
Remove trailing white-spaces.
2011-10-23 22:15:20 +02:00
d62c51ddc2
-fix documentation from a module which has *only* documentation
...
This is #10466 . It didn't crash for me, but also didn't work.
The issue was that a line ending with something else than a # was considered as the
end of the documentation block. If there was simply the end of the file we didn't
get into the correct branch.
Alex
2010-05-08 10:10:19 +02:00
2c6f8de2cc
Fix for bug #0010466 , fix crash in --help-module.
2010-03-26 16:57:01 -04:00
0ae0780055
BUG 9961: ctest --help should not display a Generators section
2009-11-24 11:46:06 -05:00
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
32258b44bc
ENH: Document CACHE entry properties
...
This adds a property documentation section for CACHE properties.
We document the ADVANCED, HELPSTRING, TYPE, and VALUE properties.
2009-03-10 11:11:15 -04:00
46e3956349
COMP: Fix assignment inside condition
2008-10-11 15:35:30 -04:00
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
657627c231
BUG: Fix help type for filenames with many dots
...
The help page type should be determined using only the extension after
the last dot. See issue #7797 .
2008-10-10 11:23:17 -04:00
d632b96841
BUG: fix 6647 arguments after -E should not be parsed by CMake
2008-08-19 15:42:48 -04:00
4175b514fc
ENH: handle HTML documentation for single items better: no warning about
...
ComputeSectionLinkPrefix, don't create an index for only one item
Alex
2008-07-21 17:52:59 -04:00
7173f2db0e
ENH: add master index into html full help
2008-03-05 11:05:22 -05:00
d47a5951ed
ENH: add --help-policies and --help-policy command line options
2008-03-04 09:16:33 -05:00
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
95ba817b2e
BUG: actually print the docs for custom modules if this was requested
...
Alex
2008-02-17 14:04:01 -05:00
f8f232bdd8
BUG: make -help-module-list work by filling the modules section first, also
...
for custom modules
Alex
2008-01-14 17:05:09 -05:00
4d9259c15b
STYLE: Spelling fixes on documentation
2008-01-09 22:09:19 -05:00
acb27977f0
ENH: sort the module files alphabetically when generating the documentation
...
of rht modules
Alex
2008-01-09 16:59:01 -05:00
f3ea6a351a
BUG: create modules documentation not only for the first documentation creation step
...
in cmake (the set ModulesFound wasn't cleared at the beginning of each
PrintDocumentation() function, so when documentation for modules was executed the second
time, ModulesFound already contained all modules and so no module was
documented)
Alex
2007-12-29 11:53:36 -05:00
ad581280a5
BUG: fix single module generation
2007-11-29 10:23:26 -05:00
c2f0aac146
ENH: some more cleanup, fixes, and patch for HTML output
2007-10-24 11:36:47 -04:00
8b76142f00
COMP: fix a problem with a shadowed var
2007-10-23 10:07:40 -04:00
b6f1cb4edf
COMP: fix some warnings and add some doc strings back in
2007-10-22 16:41:15 -04:00
44cce51a1a
COMP: fix some warnings and add some doc strings back in
2007-10-22 15:33:19 -04:00
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
8d32d229a3
ENH: make commands lower case by default
2007-10-10 11:47:43 -04:00
35e13b11f3
BUG: revert doc changes since VS7 cannot compile them, will implement them in a different manner
2007-10-09 14:35:25 -04:00
18ce24c748
ENH: make documentation entries actually store their data
2007-10-09 09:55:42 -04:00
40fa85883c
STYLE: fix line lengths
...
Alex
2007-09-20 08:33:07 -04:00
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
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
9ec10993f8
BUG: properties and module names are case sensitive
...
Alex
2007-08-09 08:48:56 -04:00
55303d6dd2
STYLE: fix line lengths
...
Alex
2007-07-20 08:36:16 -04:00
9f16292b6a
STYLE: sort the property documentation into
...
global/directory/target/test/sourcefile and variable sections
Alex
2007-07-11 15:53:58 -04:00
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
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
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
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
e37f8e2964
STYLE: create command documentation for ctest
...
I think some of the cmake commands should be removed from ctest if possible,
like add_executable etc.
Alex
2007-06-08 16:06:33 -04:00
bc8f3d504a
BUG: Patch from Alex to fix single-command help broken by previous patch.
2007-02-06 15:05:56 -05:00
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
1e566707da
COMP: Patch from Alex for const correctness.
2007-01-22 10:52:24 -05:00
1dd5db0235
COMP: fix some warnings and style issues
2006-12-08 09:27:52 -05:00
27379d7b08
ENH: make properties a bit more formal with documentation and chaining
2006-12-07 09:45:32 -05:00
49bf0b9e3d
ENH: Make hyperlinks in documentation active when generated into HTML documents. This addresses bug#3906.
2006-10-16 14:52:31 -04:00
cfb3c9eaa9
BUG: potential segfault
2006-10-06 14:00:35 -04:00
1bdebd7da6
ENH: Adding links to web resources and FAQ to SEE ALSO section. This addresses bug #3757 .
2006-10-05 10:55:37 -04:00
211e991057
BUG: Fixed man page formatting for INSTALL command documentation. Fixed line-too-long warning.
2006-08-22 10:38:10 -04:00
14781101fd
STYLE: fix line length
2006-05-10 15:01:22 -04:00
96a46bdb44
ENH: search for help modules in the correct place for install and source tree builds
2006-04-13 23:15:48 -04:00
0cae876867
ENH: case insensitive command help
2006-04-12 09:12:01 -04:00
037487a488
ENH: make sure uncommented modules are not documented
2005-12-16 16:49:01 -05:00
4b0fd57bef
ENH: fix module documenation to handle bad docs and fix qt3 docs
2005-12-15 09:19:23 -05:00
b7fa820118
ENH: add documentation support for modules
2005-12-14 13:51:08 -05:00
0e3b1febbb
ENH: Cleanup the help a bit
2005-07-18 11:32:02 -04:00
fc70a2bb2a
ENH: Add development version support in CMake
2004-10-22 15:44:54 -04:00
04016278c6
BUG: Move documentation so that it does not apear in ctest
2004-05-10 17:53:24 -04:00
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
8020279dd6
ENH: Added --help-list-commands option.
2004-04-14 13:40:24 -04:00
7d6aaf23e9
BUG: Don't use -V as a version option. It conflicts with ctest.
2003-08-06 18:43:49 -04:00
b78888fe38
ENH: Added configuration of name of executable in man page header and version banner.
2003-08-06 14:49:52 -04:00
c4794319c7
ENH: Added support to --help to print help for a single command.
2003-08-05 18:10:45 -04:00
fde552ea6e
ENH: CheckOptions now takes const argv.
2003-07-23 17:27:34 -04:00
90397af164
BUG: Text dump of documentation should be in ascii mode.
2003-07-21 14:58:07 -04:00
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
6167fa8aa2
ERR: Added missing std::.
2003-07-08 00:28:23 -04:00
ed273acfa7
ENH: Improved name of cmake version variables. They are now CMake_VERSION (major.minor) and CMake_VERSION_FULL (major.minor.patch).
2003-07-07 23:20:30 -04:00
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
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
3bba5f587e
ENH: Running with zero arguments now produces usage.
2003-04-02 22:44:42 -05:00
610da00d51
ERR: Fixed signed/unsigned warning.
2003-02-19 08:52:45 -05:00
5e18bec8f7
ENH: Re-implemented document generation class to be more organized and more robust.
2003-02-18 20:42:02 -05:00
d54e7a6888
Minor documentation fixes
2003-02-17 09:56:41 -05:00
07cdd0e60c
ENH: Added header before list of commands in generated docs. Made options more intuitive.
2003-02-17 09:42:13 -05:00
7d1ee1d4c8
ERR: Use of stream format flags is hard to make portable. Manually implementing justification.
2003-02-16 11:57:20 -05:00
caa074e8b5
ERR: Use of std::ios::fmtflags is not portable to older compilers.
2003-02-15 22:36:06 -05:00
dec0b51066
ENH: Improved formatting of plain-text help to add a blank line before the beginning of a preformatted section.
2003-02-14 16:16:06 -05:00
0005e70c05
ENH: Further improved formatting. HTML/man/help now all have a consistent appearance.
2003-02-14 13:28:46 -05:00
2c7a05edd2
ENH: Improved formatting of documentation.
2003-02-14 13:06:37 -05:00
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
Nicolas Despres
Alex Neundorf
Bill Hoffman
Zach Mullen
Brad King
Ken Martin
Amitha Perera
Andy Cedilnik