summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'macro_doc_cleanups'Brad King2018-11-191-5/+5
|\ | | | | | | | | | | | | b82526c654 Help: Minor grammar and typo corrections for macro command docs Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2622
| * Help: Minor grammar and typo corrections for macro command docsCraig Scott2018-11-151-5/+5
| | | | | | Follow-up to !2616, specifically commit 22cca9b810
* | CMP0083: fix warning message on try_compileMarc Chevrier2018-11-191-1/+2
|/ | | | Fixes: #18593
* Help: describe differences between macro and function.Joachim Wuttke (l)2018-11-142-10/+38
|
* Help: in macro vs function example, use lowercase names.Joachim Wuttke (l)2018-11-141-5/+5
| | | | | | Follow our own advise not to change cases. Omit the leading underscore.
* Help: Document that function invocation is case-insensitiveJoachim Wuttke (l)2018-11-131-21/+46
|
* Help: Document that macro invocation is case-insensitiveJoachim Wuttke (l)2018-11-131-16/+42
|
* Merge topic 'macro'Brad King2018-11-131-1/+6
|\ | | | | | | | | | | | | dcf11cbcdc Help: Mention endmacro argument as legacy only. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2606
| * Help: Mention endmacro argument as legacy only.Joachim Wuttke (l)2018-11-131-1/+6
| | | | | | | | Same change as previously done for function, if, while, ...
* | If: Support the 'DEFINED CACHE{}' syntaxRobert Maynard2018-11-091-5/+4
|/
* Help: Document if(DEFINED ENV{name})Joachim Wuttke (h)2018-11-081-7/+9
|
* Help: short/long variable reference in if commandJoachim Wuttke (l)2018-11-081-1/+5
| | | | | Explain that the short form of variable references in the if command does not apply to ENV and CACHE vars.
* Help: Clarify effect of set(ENV{..} ..) and unset(ENV{..})Joachim Wuttke (h)2018-11-082-5/+20
| | | | | | | Explain that the commands affect only the current CMake process, not the process from which CMake was called, nor the system environment at large, nor the environment of subsequent build or test processes.
* Help: Add documentation and release notes for installKyle Edwards2018-11-071-4/+109
| | | | | This change adds documentation for the new DESTINATION behavior of the install() command.
* Merge topic 'no-smiley'Brad King2018-10-295-5/+5
|\ | | | | | | | | | | | | 24fa04018c Help: Spell out ";-list" as "semicolon-separated list" Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2528
| * Help: Spell out ";-list" as "semicolon-separated list"Joachim Wuttke (o)2018-10-255-5/+5
| |
* | Merge topic 'doc-updates'Brad King2018-10-263-4/+16
|\ \ | | | | | | | | | | | | | | | | | | 2f9c253961 Help: clarify "LINKER:" prefix usage Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2530
| * | Help: clarify "LINKER:" prefix usageMarc Chevrier2018-10-263-4/+16
| | | | | | | | | | | | Fixes: #18503
* | | Help: Back-reference from find_package() to "Find Modules"Joachim Wuttke (o)2018-10-251-2/+3
| | | | | | | | | | | | viz., to section "Find Modules" in cmake-modules.7
* | | Merge topic 'deprecation'Brad King2018-10-2516-16/+32
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | c8e8c9cc7c Help: Date deprecation of deprecated commands. 19998d7b3c Help: Use 'deprecated' template, and date deprecation of modules dc1bb33578 Help: Add version number to deprecation note Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2523
| * | | Help: Date deprecation of deprecated commands.Joachim Wuttke (o)2018-10-2516-16/+32
| | |/ | |/|
* | | Help: Apply syntax highlighting to project commandsJoachim Wuttke (o)2018-10-2545-103/+108
|/ / | | | | | | | | | | * Replace most "::" by ".. code-block:: cmake" * Header sentence in imperative voice, detailed command description in present tense.
* | Merge topic 'scripting-commands'Brad King2018-10-2441-319/+472
|\ \ | | | | | | | | | | | | | | | | | | c2efb3efcd Help: Revise docs on Scripting Commands Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2504
| * | Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-2341-319/+472
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge topic 'doc-target_link_libraries-item-quoting'Brad King2018-10-191-0/+12
|\ \ \ | |/ / |/| | | | | | | | | | | | | | 18cff26e3a Help: Clarify command-line encoding of target_link_libraries items Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2503
| * | Help: Clarify command-line encoding of target_link_libraries itemsBrad King2018-10-181-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | Items that have full paths will be quoted automatically. Other items are treated as command-line string fragments and get no automatic escaping. Document the behavior for each item kind. Fixes: #18467
| * | Merge branch 'doc-target_link_libraries-keywords-not-genex' into release-3.13Brad King2018-10-081-6/+18
| |\ \ | | | | | | | | | | | | Merge-request: !2449
| * \ \ Merge branch 'project-always-set-desc-url' into release-3.13Brad King2018-10-081-0/+2
| |\ \ \ | | | | | | | | | | | | | | | Merge-request: !2457
| * \ \ \ Merge branch 'list-SORT-docs' into release-3.13Brad King2018-10-081-11/+15
| |\ \ \ \ | | | | | | | | | | | | | | | | | | Merge-request: !2453
* | | | | | Help: Override pygments CMakeLexer to support <..> and [..]Joachim Wuttke (o)2018-10-181-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * The code snippets in the docs consist of CMake code mixed with syntax definition punctuation like < > [ ] ... Therefore a pure CMake lexer is inadequate. Here it is replaced by a CMake syntax definition parser. * Fixed syntax definition snippets in FindPkgConfig.cmake to make best use of syntax highlighting. This source file is the hardest to support because it contains comparison operators <= = >=, which need special attention to avoid confusion with the placeholder indicators <...>. * Fixed syntax in execute_process.rst (there were unbalanced brackets). * Disabled syntax highlighting for long string examples in cmake-language.7.rst. * No highlighting of removed syntax in CMP0049 * To inspect the outcome of this patch, see e.g. the pages * manual/cmake-buildsystem.7.html * module/ExternalProject.html * module/FindPkgConfig.html which are particularly rich in complex code snippets.
* | | | | | Merge branch 'backport-revert-install-code-script-genex' into ↵Brad King2018-10-111-4/+0
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | revert-install-code-script-genex
| * | | | | | install: Revert CODE,SCRIPT support for generator expressionsBrad King2018-10-111-4/+0
| | |_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Revert commit v3.13.0-rc1~441^2 (install: Teach CODE,SCRIPT modes to evaluate generator expressions, 2018-05-29). Unfortunately it has been found to break existing code in a real project, e.g. install(CODE [[ message("$<FOOBAR>") ]]) Address this regression by reverting support for the 3.13 release series. Support can be restored later with a policy for compatibility. Issue: #15785 Fixes: #18435
* | | | | | Merge topic 'ctest-done'Brad King2018-10-111-0/+1
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | a6e0158712 ctest_submit: Add support for a "Done" part f460bbd4c8 ctest_submit: Refactor file list to use a vector instead of a set Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Zack Galbreath <zack.galbreath@kitware.com> Merge-request: !2405
| * | | | | | ctest_submit: Add support for a "Done" partBetsy McPhail2018-10-101-0/+1
| |/ / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Teach CTest to submit Done.xml. Submission of this file indicates to CDash that a build is complete and no more files will be uploaded. It contains the build id returned by CDash and the current time. This file is submitted last for a given build when using the `ctest_submit()` command. If submitting by PARTS, use `ctest_submit(PARTS Done)`.
* | | | | | Merge topic 'project-version'Brad King2018-10-101-59/+88
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 2f43bd3b6c Help: move description of CMAKE_PROJECT_* variables e3e5445d83 Help: Describe options of command project in a definition list. 5b56795d57 Help: make the two signatures of command "project" orthogonal Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2450
| * | | | | | Help: move description of CMAKE_PROJECT_* variablesJoachim Wuttke (o)2018-10-091-8/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Describe these variables along with the other variables.
| * | | | | | Help: Describe options of command project in a definition list.Joachim Wuttke (l)2018-10-091-51/+72
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also add section headers; explain default setting of optional argument variables.
| * | | | | | Help: make the two signatures of command "project" orthogonalJoachim Wuttke (l)2018-10-091-1/+1
| | | | | | |
* | | | | | | Help: Make synopsis of if command more compact; add section headersJoachim Wuttke (l)2018-10-091-41/+49
|/ / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also replace 'expression' by 'condition' (as in the while command); relegate optional arguments of else() and endif() to the text; revise explanation of operator precedence in Condition Syntax section.
* | | | | | Merge topic 'doc-regex-backslash'Brad King2018-10-091-6/+13
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | fab2c2339b Help: Fix documentation of escape sequences in a regex Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2460
| * | | | | | Help: Fix documentation of escape sequences in a regexBrad King2018-10-091-6/+13
| |/ / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Documentation added by commit 4b35dab891 (Help: Document how escape sequences work in a regex, 2018-07-18) is only correct for backslashes inside `[]` groups. The regex engine does interpret `\` escapes elsewhere. Fix the docs. Inspired-by: R2RT <artur.ryt@gmail.com> Fixes: #18428
* | | | | | Merge topic 'doc-target_link_libraries-keywords-not-genex'Brad King2018-10-091-6/+18
|\ \ \ \ \ \ | | |_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | cd8c79e163 Help: Clarify target_link_libraries keywords and generator expressions Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2449
| * | | | | Help: Clarify target_link_libraries keywords and generator expressionsBrad King2018-10-081-6/+18
| |/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `optimized` and `debug` keyword items are meaningful only to the `target_link_libraries` command and have no meaning when produced by a generator expression. State this explicitly. Also recommend use of a quoted argument when the genex itself may contain a semicolon. Fixes: #18424
* | | | | Merge topic 'project-always-set-desc-url'Brad King2018-10-081-0/+2
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | f8a086a86b project(): Ensure DESCRIPTION and HOMEPAGE_URL variables are set b27247c8df project(): Add tests verifying variables set by second project() call Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2457
| * | | | project(): Ensure DESCRIPTION and HOMEPAGE_URL variables are setCraig Scott2018-10-071-0/+2
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | If a project() call does not have DESCRIPTION or HOMEPAGE_URL options, it must still set the relevant variables or else those variables will inherit values from an earlier project() call. That is inconsistent with how VERSION is handled and is likely to be unexpected. The docs were also ambiguous about what should happen in such cases.
* | | | Merge topic 'list-SORT-docs'Brad King2018-10-081-11/+15
|\ \ \ \ | |_|/ / |/| | / | | |/ | |/| | | | | | | cdf8d79e9f Help: Improve/fix incorrect docs for list(SORT) sub-options Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2453
| * | Help: Improve/fix incorrect docs for list(SORT) sub-optionsCraig Scott2018-10-061-11/+15
| |/
* | Help: Clarify find_package Module and Config mode relationJoachim Wuttke (l)2018-10-041-17/+17
| |
* | Help: Remove redundant recommendationBrad King2018-10-041-12/+4
| | | | | | | | | | We suggest that users prefer the basic signature in two places. Drop the latter and move its related content to a better section.
* | Help: Add internal section link to find_package command docsJoachim Wuttke (l)2018-10-041-6/+8
| |
generated by cgit v0.12 at 2024-11-13 19:59:25 (GMT)