summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.cxx
Commit message (Collapse)AuthorAgeFilesLines
* Remove c_str calls when using stream APIs.Stephen Kelly2014-03-111-6/+6
| | | | | Use an ad-hoc clang tool for matching the calls which should be ported.
* Remove some c_str() calls.Stephen Kelly2014-03-111-1/+1
| | | | | | Use the clang RemoveCStrCalls tool to automatically migrate the code. This was only run on linux, so does not have any positive or negative effect on other platforms.
* stringapi: Use strings for documentation namesBen Boeckel2014-03-081-2/+2
|
* cmake: Implement placeholder --help-custom-modules compatibilityBrad King2014-01-081-1/+56
| | | | | | | | | | 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.
* Use cmsys::[io]fstream instead of cmsys_ios::[io]fstream.Clinton Stimpson2014-01-071-3/+4
| | | | | Also use SystemTools::Fopen() instead of fopen(). This is to eventually support utf-8 filenames.
* Merge topic 'cmake-credits'Brad King2013-11-211-2/+6
|\ | | | | | | | | 6fc4ab9 Credit Kitware and csimsoft for their maintenance roles
| * Credit Kitware and csimsoft for their maintenance rolesBrad King2013-11-191-2/+6
| | | | | | | | | | Add maintenance credit to command-line "--version" output and the cmake-gui "About" dialog.
* | cmDocumentation: Fix exit after help output format warningsBrad King2013-11-191-12/+15
|/ | | | | | | | 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-2/+3
| | | | | | | | | | | | | | | | | | | | 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-6/+38
| | | | | | | | | | | 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-27/+15
| | | | | 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-124/+37
| | | | | | | | 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-32/+277
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-992/+17
| | | | | | | | | | | | | | | | 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/+8
| | | | | | | | | | | | | | | | | | | | 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-327/+0
| | | | This will be replaced by alternative markup later.
* cmDocumentation: Drop version output from usage and text helpBrad King2013-10-151-8/+1
| | | | | Drop the "cmake version ..." line from the top of usage and text help formats. Print it only when requested with --version or similar option.
* cmake: Add --help-policy-list optionBrad King2013-10-151-0/+9
| | | | | All the other --help-<item> options have a corresponding option --help-<item>-list. Add one for --help-policy.
* Merge topic 'minor_cleanup'Brad King2013-10-071-2/+2
|\ | | | | | | | | | | | | | | 6931999 VS6: Add some delimiting between error message and content. d1a5f12 cmTarget: Fix typo in comment. 961c0ba Fix comments to match the code. 7cca50c Remove unused include.
| * Fix comments to match the code.Stephen Kelly2013-09-111-2/+2
| |
* | remove unused local typedefRolf Eike Beer2013-08-141-2/+2
|/ | | | | | | | Fixes this warning from g++ 4.8: CMake/Source/cmDocumentation.cxx:835:23: warning: typedef 'sdoc_t' locally defined but not used [-Wunused-local-typedefs] SDOC_UNKNOWN} sdoc_t; ^
* Fix spelling and typos (affecting binary data / module messages)Andreas Mohr2013-05-071-2/+2
|
* Update programmatically-reported copyright year (#13638)Brad King2012-11-051-1/+1
| | | | | Update the copyright year reported by 'bootstrap' and in the generated documentation to report 2012.
* docbook: Remove redundant docs that cause invalid DocBookDaniel Pfeifer2012-09-081-7/+0
| | | | | | If a subsection with a title is added, all subsequent subsections need a title too. The "helpful links" just repeat preceding subsections anyway.
* man documentation: detect man section from the given filenameAlex Neundorf2012-06-211-14/+33
| | | | | | | 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-5/+6
| | | | | | | | 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
* Try to fix compile error on Win32-vs70Eric NOULARD2012-02-181-3/+4
|
* Suppress unecessary (now empty) doc sectionsEric NOULARD2012-02-181-2/+0
|
* Dynamically add documentation section specified in documented script.Eric NOULARD2012-02-181-3/+18
| | | | Modify CPackDeb and CPackRPM as an example
* Fix non existent std::string::clear on VS6Eric NOULARD2012-02-141-2/+2
|
* Create getDocumentedModulesListInDir which may be used in other context.Eric NOULARD2012-02-141-0/+55
| | | | | This should makes it easier to use the same "documented module" techniques for CTest, CMake or user module.
* Make the load of script documentation more efficient and dynamic.Eric NOULARD2012-02-141-2/+18
| | | | | | | | CPack help will be searched in any CPack*.cmake file located near to CPack.cmake file. The script files is parsed iff the first line begin with ##section. Moreover the documentation section name is specified on the remaining part of the line minus the space immediately following ##section.
* Fix potential bad memory access, thanks to EikeEric NOULARD2012-01-311-1/+1
|
* Suppress unused var, beautify code, avoid 1 extra newline.Eric NOULARD2012-01-241-18/+25
| | | | | | There remains extra newlines in text Formatter output but the parser does not seem to be the culprit. The formatter should be.
* CPack Documentation extraction from CMake script begins to workEric NOULARD2012-01-221-32/+108
| | | | | | | | | | - 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/+171
| | | | | | | | | 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-49/+83
| | | | | | 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.
* Usage: Document all options printing the version number.Nicolas Despres2011-10-231-1/+2
|
* Usage: Document all options printing usage information.Nicolas Despres2011-10-231-1/+1
|
* Remove trailing white-spaces.Nicolas Despres2011-10-231-76/+76
|
* -fix documentation from a module which has *only* documentationAlex Neundorf2010-05-081-12/+14
| | | | | | | | | 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
* Fix for bug #0010466, fix crash in --help-module.Bill Hoffman2010-03-261-5/+12
|
* BUG 9961: ctest --help should not display a Generators sectionZach Mullen2009-11-241-1/+6
|
* Convert CMake to OSI-approved BSD LicenseBrad King2009-09-281-32/+25
| | | | | | | 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: Document CACHE entry propertiesBrad King2009-03-101-0/+1
| | | | | This adds a property documentation section for CACHE properties. We document the ADVANCED, HELPSTRING, TYPE, and VALUE properties.
* COMP: Fix assignment inside conditionBrad King2008-10-111-2/+2
|
* ENH: Improve generated documentation formattingBrad King2008-10-101-10/+113
| | | | | | | | | | | | 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 help type for filenames with many dotsBrad King2008-10-101-1/+1
| | | | | The help page type should be determined using only the extension after the last dot. See issue #7797.
* BUG: fix 6647 arguments after -E should not be parsed by CMakeBill Hoffman2008-08-191-1/+6
|
* ENH: handle HTML documentation for single items better: no warning aboutAlexander Neundorf2008-07-211-1/+3
| | | | | | ComputeSectionLinkPrefix, don't create an index for only one item Alex
generated by cgit v0.12 at 2025-01-05 01:50:22 (GMT)