summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-developer.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Rewrite the cmake-developer.7 find module documentationAlex Merry2014-04-021-175/+370
| | | | | | | | | | | | | | As well as the traditional variables, providing imported targets is suggested, and the relative advantages and disadvantages briefly discussed. A mini-tutorial walking through creating a simple find module is provided. This changes the recommended version variable from Foo_VERSION_STRING to Foo_VERSION, because there is really no need to have different variable names for package version files vs. find modules. It notes the old variable name, though, and suggests setting it for compatibility.
* Help: Drop cmStdString from cmake-developer(7) examplesBrad King2014-03-131-6/+6
| | | | The type no longer exists within CMake.
* Help: Fix typoStephen Kelly2014-02-171-2/+2
| | | | binary_find -> binary_search.
* Help: Add a style guide.Stephen Kelly2014-02-061-2/+167
|
* Help: Fix typosStephen Kelly2014-02-061-1/+1
| | | | | | | | Psuedo -> Pseudo behaviour -> behavior CMake uses American spelling.
* Help: Note that std::string::clear may not be used.Stephen Kelly2014-01-271-4/+6
| | | | | As found in commit 519c0a5d (Can't use std::string::clear() in cmake., 2012-09-15).
* Help: Document non-use of std::set::insert.Stephen Kelly2014-01-271-0/+23
| | | | | As found in commit 8e7c207e (Use a manual loop to insert into set::set., 2012-09-15).
* Help: Document the C++ subset permitted for CMake code.Stephen Kelly2014-01-061-0/+159
| | | | | This may be incomplete, but further limitations can be added when needed.
* Help: Reference cmake-language.7 comment docs from cmake-developer.7Brad King2013-11-081-2/+3
| | | | | | The cmake-language.7 manual now documents comment syntax. Reference it from cmake-developer.7 when discussing how to add comment-enclosed documentation to modules.
* cmRST: Add support for the note and productionlist directivesBrad King2013-10-301-0/+10
| | | | | | Simply print out the lines as normal paragraph text. Teach the CMakeLib.testRST test to cover this syntax. Update the cmake-developer.7 manual to document support for the directives.
* Help: Glob manual/*.rst in Sphinx configurationBrad King2013-10-301-0/+2
| | | | | | | 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.
* cmRST: Teach cmake-module directive to scan bracket commentsBrad King2013-10-231-6/+22
| | | | | | | | | | | | | | | | When scanning CMake module files for .rst comments, recognize bracket comments starting in ".rst:" too. For example: #[[.rst: Include the bracket comment content terminated by the closing bracket. Exclude the line containing the bracket if it starts in "#". Teach the CMakeLib.testRST test to cover multiple bracket lengths and ending brackets on lines with and without "#". Update the cmake-developer.7 manual to document the bracket-comment syntax for .rst documentation.
* cmake-developer.7: Improve flow of module documentation instructionsBrad King2013-10-231-17/+18
| | | | | Use prose instead of enumerated steps and re-order the steps so that the cmake-module directive is covered contiguously.
* cmRST: Cross-reference cmake-developer.7 manual and cmRST DoxygenBrad King2013-10-221-0/+3
| | | | | | The cmRST implementation and the list of capabilities documented in the cmake-developer.7 manual must be kept in sync. Add a note to each file to reference the other.
* Help: Add documentation format to cmake-developer.7 manualBrad King2013-10-221-0/+205
| | | | | | Document how CMake uses reStructuredText to provide the help manuals. Cover supported inline markup and directives, the CMake Domain in Sphinx, and cross-reference syntax.
* Help: Organize cmake-developer.7 manual Modules sectionBrad King2013-10-221-50/+74
| | | | | | Add "Module Documentation" and "Find Modules" subsections. Add to Modules/readme.txt a textual reference to the cmake-developer.7 manual and, while at it, fix the wiki URL domain.
* Help: Fix module documentation markup in cmake-developer.7 manualKitware Robot2013-10-221-102/+161
| | | | | | | Convert the content moved from Modules/readme.txt to valid reStructuredText markup. Mainly, convert the lists of variables to definition lists, wrap long lines in paragraph text, and add literal block markup and indentation.
* Help: Move Modules/readme.txt content into cmake-developer.7 manualKitware Robot2013-10-221-0/+188
| | | | | | | Move all content from Modules/readme.txt except for the link to the module maintainers wiki page into "Help/manual/cmake-developer.7.rst". This produces some invalid reStructuredText markup to be fixed in a future commit.
* Help: Add cmake-developer.7 manualBrad King2013-10-221-0/+18
Add the manual with just an introduction section. Leave section headers for Help and Modules to be filled in later.