summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
Commit message (Collapse)AuthorAgeFilesLines
* stringapi: Use strings for documentation namesBen Boeckel2014-03-081-1/+1
|
* cmake: Implement placeholder --help-custom-modules compatibilityBrad King2014-01-081-0/+1
| | | | | | | | | | The implementation of the "cmake --help-custom-modules" was removed along with the rest of the old help generation infrastructure when documentation was converted to reStructuredText. In order to avoid breaking existing project builds outright when they use a custom command that runs a command like "cmake --help-custom-modules foo.1", generate the requested file with placeholder content explaining that the option is not supported anymore.
* cmDocumentation: Fix exit after help output format warningsBrad King2013-11-191-1/+1
| | | | | | | | After warning that a help output format is no longer supported, fix the return value from cmDocumentation::CheckOptions to indicate that it was still a help option that was parsed. Otherwise CMake moves on to treat the help output file name as a source tree and complains that it does not exist.
* Refactor internal resource location APIs and initializationBrad King2013-11-121-4/+0
| | | | | | | | | | | | | | | | | | | | Rename cmSystemTools::FindExecutableDirectory to FindCMakeResources. Teach it to compute the locations of cmake, ctest, cpack, ccmake, and cmake-gui executables, and the location of CMAKE_ROOT. Provide this information from static cmSystemTools::Get<resource>() methods. Refactor code that needs these locations to use the new APIs. Teach FindCMakeResources to use the OS X system API to lookup the executable location. When running from the CMake build tree itself, leave a file in the tree that FindCMakeResources can use to read the location of the source tree. This avoids the need to compile the source tree location into a binary that may be installed and used without the source tree. Teach the QtDialog on OS X to create a "cmake-gui" symlink in the build tree next to "cmake" and the other tools, as is already done in the install tree for the application bundle. This ensures a consistent set of executables are available in one directory.
* Make --help-* options available from all command-line toolsBrad King2013-10-161-1/+1
| | | | | | | | | | | 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.
* Drop the 'Full' field from cmDocumentationEntryBrad King2013-10-161-3/+3
| | | | | We need only 'Brief' for usage documentation. We no longer have builtin 'Full' documentation, which is now in Help/*/*.rst files.
* Drop all documentation formatters except UsageBrad King2013-10-161-42/+4
| | | | | | | | We now need only the Usage formatter to support command-line options that print basic usage, and the supporting indented=>preformatted markup processor to support CMake message formatting. Drop all other documentation formatters and move the remaining code up into the top cmDocumentationFormatter class.
* Teach --help-* options to load documentation from .rst filesBrad King2013-10-161-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Install the Help directory next to Modules to make it available in CMake distributions. Use cmRST to read Help .rst documents and print them as help output. Add options --help-manual-list --help-manual to list available manuals or print one of them. Implement the options --help-commands --help-modules --help-policies --help-properties --help-variables by mapping to the corresponding manual page. Implement the options --help-command-list --help-module-list --help-policy-list --help-property-list --help-variable-list by globbing the available Help .rst documents of the corresponding type and reading their titles. Implement the options --help-command --help-module --help-policy --help-property --help-variable by globbing the matching Help .rst document(s) and printing them.
* Drop "full" documentation output typesBrad King2013-10-151-67/+2
| | | | | | | | | | | | | | | | We will no longer support full documentation generation from executables and will instead generate documentation with other tools. Disable (with a warning left behind) the command-line options: --copyright --help-compatcommands --help-full --help-html --help-man Drop supporting code. Drop manual sections generation from executables. Remove internal documentation construction APIs. Drop unused sections See Also, Author, Copyright, Compat Commands, Custom Modules.
* Add reStructuredText (RST) documentation formatterBrad King2013-10-151-0/+2
| | | | | | | | | | | | | | | | | | | | Temporarily add a RST formatter to convert builtin documentation to .rst source files. This will be removed shortly after we use it to convert documentation. Teach the RST formatter to: * Output preformatted blocks as reStructuredText "::" literal blocks. * Output option lists as bullet lists with option names enclosed in reStructuredText ``literal`` quoting. * Output individual documentation objects (commands, variables, etc.) in separate .rst files organized in directories by type. Replace references to cmVersion::GetCMakeVersion() in builtin documentation with the literal placeholder "|release|" that will be defined as a substitution later.
* Drop CPack module documentation markup extractionBrad King2013-10-151-38/+0
| | | | This will be replaced by alternative markup later.
* cmDocumentation: Fix a few doxygen comment errorsSean McBride2013-10-081-7/+6
| | | | Warned by clang -Wdocumentation
* man documentation: detect man section from the given filenameAlex Neundorf2012-06-211-1/+2
| | | | | | | E.g. if you say cmake --help-custom-modules mymodules.7 cmake will now put section 7 into the generated manpage. Alex
* documentation: preparation for making the man section configurableAlex Neundorf2012-06-211-3/+4
| | | | | | | | This patch adds a man section number, which is then used by the DocumentationFormatterMan. The section number is right now always 1, detecting this from the file name will be the next step. Alex
* -remove trailing whitespaceAlex Neundorf2012-06-211-14/+14
| | | | Alex
* Dynamically add documentation section specified in documented script.Eric NOULARD2012-02-181-2/+4
| | | | Modify CPackDeb and CPackRPM as an example
* Create getDocumentedModulesListInDir which may be used in other context.Eric NOULARD2012-02-141-1/+32
| | | | | This should makes it easier to use the same "documented module" techniques for CTest, CMake or user module.
* Fix another compiler warning due to a typoEric NOULARD2012-02-141-1/+0
|
* CPack Documentation extraction from CMake script begins to workEric NOULARD2012-01-221-4/+7
| | | | | | | | | | - Enhance extract doc parser. Seems robust now. The legacy module documentation parser works as before ignoring the new markup. - Proof of concept for CPack (generic), CPack RPM and CPack Deb generator for macro and variables. Try cpack --help-command and cpack --help-variables
* Implement simple CMake script comment markup language.Eric NOULARD2012-01-221-0/+23
| | | | | | | | | The language is very simple. It use ##<keyword> special comment which opens a structured documentation block and ##end closes it. This may be used to extract documentation for macro as 'command' and 'variables' such that cpack --help-command and --help-variable does parse builtin modules files (CPack.cmake, CPackComponent.cmake, ...) in order to extract the corresponding doc.
* CPack begin the implementation of --help-command* and --help-variables*Eric NOULARD2012-01-221-0/+12
| | | | | | This modifications set tries to keep the unified doc for cmake/ctest/cpack while introducing tool specific documentation separated. Some documentation sections for CMake do not fit well to CPack.
* BUG 9961: ctest --help should not display a Generators sectionZach Mullen2009-11-241-0/+4
|
* Convert CMake to OSI-approved BSD LicenseBrad King2009-09-281-14/+9
| | | | | | | 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.
* ENH: Improve generated documentation formattingBrad King2008-10-101-1/+7
| | | | | | | | | | | | 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.
* BUG: fix 6647 arguments after -E should not be parsed by CMakeBill Hoffman2008-08-191-2/+5
|
* ENH: add --help-policies and --help-policy command line optionsKen Martin2008-03-041-0/+2
|
* ENH: add support for creating the documentation in docbook formatAlexander Neundorf2008-02-191-0/+2
| | | | | | | | (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
* ENH: some more cleanup, fixes, and patch for HTML outputKen Martin2007-10-241-1/+11
|
* COMP: fix some warnings and add some doc strings back inKen Martin2007-10-221-0/+8
|
* ENH: change to make the documentation class more generic, about halfway ↵Ken Martin2007-10-221-120/+27
| | | | there, also provides secitons for Variables now
* ENH: add new help option --help-custom-modules, which generatesAlexander Neundorf2007-09-191-1/+18
| | | | | | | | | | | 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
* STYLE: move the code for the different formats of the generated help intoAlexander Neundorf2007-09-191-52/+13
| | | | | | | their own classes, making cmDocumentation smaller and also making it easier to eventually add another format Alex
* STYLE: sort the property documentation intoAlexander Neundorf2007-07-111-9/+18
| | | | | | global/directory/target/test/sourcefile and variable sections Alex
* COMP: fix compile on HP-UX with aCC, reusing the same identifier for aAlexander Neundorf2007-07-031-3/+3
| | | | | | variable as for the enum type doesn't work here Alex
* COMP: fix build with msvc 6, the enums are now part of a class which isAlexander Neundorf2007-07-021-15/+24
| | | | | | already completely parsed Alex
* ENH: generate separate documentation for the commands, compatiblityAlexander Neundorf2007-06-281-3/+8
| | | | | | | | 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
* ENH:Alexander Neundorf2007-06-281-13/+20
| | | | | | | | | | | | -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
* ENH: put compatibility commands in extra section and prepare for creatingAlexander Neundorf2007-06-221-0/+7
| | | | | | | separate man pages for properties, modules, commands and compatibility commands Alex
* COMP: Fix void return failure.Brad King2007-02-021-1/+1
|
* STYLE: Fixed line length and this-> convention violations from yesterday's ↵Brad King2007-02-021-6/+12
| | | | patch.
* ENH: Patch from Alex to improve implementation and prepare for splitting the ↵Brad King2007-02-011-12/+66
| | | | man page into more sections.
* COMP: Patch from Alex for const correctness.Brad King2007-01-221-2/+2
|
* ENH: make properties a bit more formal with documentation and chainingKen Martin2006-12-071-1/+9
|
* ENH: search for help modules in the correct place for install and source ↵Bill Hoffman2006-04-141-1/+4
| | | | tree builds
* ENH: add documentation support for modulesBill Hoffman2005-12-141-1/+10
|
* ENH: Renamed --help-list-commands to --help-command-list and split --help ↵Brad King2004-04-141-10/+13
| | | | [command] into separate --help and --help-command cmd options.
* ENH: Added --help-list-commands option.Brad King2004-04-141-1/+2
|
* ENH: Added configuration of name of executable in man page header and ↵Brad King2003-08-061-0/+6
| | | | version banner.
* ENH: Added support to --help to print help for a single command.Brad King2003-08-051-0/+2
|
* ENH: CheckOptions now takes const argv.Brad King2003-07-231-1/+1
|
generated by cgit v0.12 at 2025-01-01 10:25:08 (GMT)