summaryrefslogtreecommitdiffstats
path: root/Help/command/cmake_policy.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
* Help: Improve description of modulesBartosz Kosiorek2019-04-231-1/+1
|
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-4/+8
| | | | | | | | | | | | | | | | | | | Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
* Help: Clarify ...<max> behavior for policy-related commandsCraig Scott2018-07-011-1/+4
| | | Affects cmake_minimum_required() and cmake_policy(VERSION)
* cmake_minimum_required: Optionally set policies with version rangeBrad King2018-03-211-8/+13
| | | | | | | | Teach `cmake_minimum_required` and `cmake_policy(VERSION)` to support a version range of the form `<min>[...<max>]`. Define this to mean that version `<min>` is required, but known policies up to those introduced by `<max>` will be set to `NEW`. This will allow projects to easily specify a range of versions for which they have been updated.
* Help: Document explicitly that policy OLD behavior is deprecatedBrad King2015-06-091-0/+2
| | | | | | | | | | | The most likely documentation page a project author will read in response to a policy warning is the page for the policy itself. Add to every policy documentation page a note explicitly stating that the OLD behavior is deprecated. Also mention this in the cmake_policy() command documentation that explains how to set a policy to OLD. Suggested-by: Fraser Hutchison <fraser.hutchison@gmail.com>
* Help: Use "^^^^" for subsubsection headersBrad King2014-06-021-4/+4
| | | | | | This is the convention suggested in the Sphinx documentation and is already used in several other places in the CMake documentation. Update a few places where we were using other characters.
* Help: Reference cmake_minimum_required from cmake_policy docsBrad King2014-05-301-0/+6
| | | | | | | Note in a few places of the cmake_policy() command documentation that the cmake_minimum_required() command can set policies too. Inspired-by: Peter Kümmel <syntheticpp@gmx.net>
* Help: Format cmake_policy command documentationBrad King2014-05-301-35/+45
| | | | | Add reStructuredText markup manually to improve formatting of the documentation. Organize the documentation into subsections.
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+78
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.