Commit Graph

547 Commits

Author SHA1 Message Date
Joachim Wuttke (h)
e855bd5248 Help: Document if(DEFINED ENV{name}) 2018-11-08 20:30:05 +01:00
Joachim Wuttke (l)
8ba2a8d4a4 Help: short/long variable reference in if command
Explain that the short form of variable references
in the if command does not apply to ENV and CACHE vars.
2018-11-08 20:27:49 +01:00
Joachim Wuttke (h)
3de551cc22 Help: Clarify effect of set(ENV{..} ..) and unset(ENV{..})
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.
2018-11-08 20:27:10 +01:00
Kyle Edwards
fdcd559a8e Help: Add documentation and release notes for install
This change adds documentation for the new DESTINATION behavior of
the install() command.
2018-11-07 15:47:21 -05:00
Brad King
f0a9094d80 Merge topic 'no-smiley'
24fa04018c Help: Spell out ";-list" as "semicolon-separated list"

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2528
2018-10-29 09:30:25 -04:00
Brad King
f7b8e67463 Merge topic 'doc-updates'
2f9c253961 Help: clarify "LINKER:" prefix usage

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2530
2018-10-26 11:02:09 -04:00
Marc Chevrier
2f9c253961 Help: clarify "LINKER:" prefix usage
Fixes: #18503
2018-10-26 09:36:53 -04:00
Joachim Wuttke (o)
760c87c73c Help: Back-reference from find_package() to "Find Modules"
viz., to section "Find Modules" in cmake-modules.7
2018-10-25 21:44:02 +02:00
Brad King
bb43a42bb9 Merge topic 'deprecation'
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
2018-10-25 11:00:57 -04:00
Joachim Wuttke (o)
24fa04018c Help: Spell out ";-list" as "semicolon-separated list" 2018-10-25 15:44:59 +02:00
Joachim Wuttke (o)
adbaadf0ee Help: Apply syntax highlighting to project commands
* Replace most "::" by ".. code-block:: cmake"
  * Header sentence in imperative voice,
    detailed command description in present tense.
2018-10-25 13:47:31 +02:00
Joachim Wuttke (o)
c8e8c9cc7c Help: Date deprecation of deprecated commands. 2018-10-25 13:15:34 +02:00
Brad King
008cb6aa99 Merge topic 'scripting-commands'
c2efb3efcd Help: Revise docs on Scripting Commands

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2504
2018-10-24 10:39:39 -04:00
Joachim Wuttke (l)
c2efb3efcd Help: Revise docs on Scripting Commands
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
2018-10-23 15:12:10 +02:00
Brad King
b142956829 Merge topic 'doc-target_link_libraries-item-quoting'
18cff26e3a Help: Clarify command-line encoding of target_link_libraries items

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2503
2018-10-19 09:47:53 -04:00
Joachim Wuttke (o)
fc7ee1ca45 Help: Override pygments CMakeLexer to support <..> and [..]
* 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.
2018-10-19 07:25:34 +11:00
Brad King
18cff26e3a Help: Clarify command-line encoding of target_link_libraries items
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
2018-10-18 13:31:24 -04:00
Brad King
fd0e40f166 Merge branch 'backport-revert-install-code-script-genex' into revert-install-code-script-genex 2018-10-11 08:14:48 -04:00
Brad King
2e1fe8fabe Merge topic 'ctest-done'
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
2018-10-11 07:32:54 -04:00
Brad King
0f48fbaa72 install: Revert CODE,SCRIPT support for generator expressions
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
2018-10-11 07:05:55 -04:00
Brad King
b62d15c216 Merge topic 'project-version'
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
2018-10-10 07:05:03 -04:00
Betsy McPhail
a6e0158712 ctest_submit: Add support for a "Done" part
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)`.
2018-10-10 06:55:59 -04:00
Joachim Wuttke (o)
2f43bd3b6c Help: move description of CMAKE_PROJECT_* variables
Describe these variables along with the other variables.
2018-10-09 15:28:53 +02:00
Joachim Wuttke (l)
e3e5445d83 Help: Describe options of command project in a definition list.
Also add section headers;
explain default setting of optional argument variables.
2018-10-09 14:29:57 +02:00
Joachim Wuttke (l)
5b56795d57 Help: make the two signatures of command "project" orthogonal 2018-10-09 14:22:09 +02:00
Joachim Wuttke (l)
ba90611225 Help: Make synopsis of if command more compact; add section headers
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.
2018-10-09 14:04:24 +02:00
Brad King
3ea9d81da6 Merge topic 'doc-regex-backslash'
fab2c2339b Help: Fix documentation of escape sequences in a regex

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2460
2018-10-09 06:34:06 -04:00
Brad King
fab2c2339b Help: Fix documentation of escape sequences in a regex
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
2018-10-09 06:31:37 -04:00
Brad King
db8920a2c5 Merge topic 'doc-target_link_libraries-keywords-not-genex'
cd8c79e163 Help: Clarify target_link_libraries keywords and generator expressions

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2449
2018-10-09 06:25:13 -04:00
Brad King
c268fcc2ed Merge branch 'doc-target_link_libraries-keywords-not-genex' into release-3.13
Merge-request: !2449
2018-10-08 11:52:39 -04:00
Brad King
c3e27c2562 Merge topic 'project-always-set-desc-url'
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
2018-10-08 11:26:21 -04:00
Brad King
c76e024a3d Merge topic 'list-SORT-docs'
cdf8d79e9f Help: Improve/fix incorrect docs for list(SORT) sub-options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2453
2018-10-08 11:25:38 -04:00
Brad King
c2356d60d8 Merge branch 'project-always-set-desc-url' into release-3.13
Merge-request: !2457
2018-10-08 11:21:48 -04:00
Brad King
bad9bc78e3 Merge branch 'list-SORT-docs' into release-3.13
Merge-request: !2453
2018-10-08 11:21:23 -04:00
Brad King
cd8c79e163 Help: Clarify target_link_libraries keywords and generator expressions
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
2018-10-08 11:18:14 -04:00
Craig Scott
f8a086a86b project(): Ensure DESCRIPTION and HOMEPAGE_URL variables are set
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.
2018-10-08 08:28:17 +11:00
Craig Scott
cdf8d79e9f Help: Improve/fix incorrect docs for list(SORT) sub-options 2018-10-06 18:10:38 +10:00
Joachim Wuttke (l)
c90f3dff82 Help: Clarify find_package Module and Config mode relation 2018-10-04 16:43:40 -04:00
Brad King
26dac50220 Help: Remove redundant recommendation
We suggest that users prefer the basic signature in two places.
Drop the latter and move its related content to a better section.
2018-10-04 16:43:02 -04:00
Joachim Wuttke (l)
11058a2e7c Help: Add internal section link to find_package command docs 2018-10-04 16:42:42 -04:00
Joachim Wuttke (l)
aaf5ea2d70 Help: Add section headers to find_package command
The document is pretty long but is already mostly organized into
sections.  Add explicit section headers.
2018-10-04 14:57:56 -04:00
Joachim Wuttke (l)
56310b0671 Help: Move find_package NO_POLICY_SCOPE to more appropriate location 2018-10-04 14:57:56 -04:00
Joachim Wuttke (l)
336dce1c95 Help: Add table of contents to find_package command docs 2018-10-04 14:57:55 -04:00
Joachim Wuttke (l)
463d59d331 Help: Rephrase summary in find_package command docs 2018-10-04 14:57:49 -04:00
Kyle Edwards
fbd89b6753 Help: Add note about CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS 2018-10-01 16:10:33 -04:00
Brad King
cac09cc52c Merge topic 'customcommandworkingdirectory'
f158ac19e1 add_custom_{command,target}: WORKING_DIRECTORY generator expressions

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2409
2018-09-28 11:17:09 -04:00
Jon Chronopoulos
f158ac19e1 add_custom_{command,target}: WORKING_DIRECTORY generator expressions
This teaches add_custom_command and add_custom_target WORKING_DIRECTORY
about generator expressions

Fixes: #14089
2018-09-28 11:15:33 -04:00
Marc Chevrier
f9717725f9 link_directories(): enhance capabilities 2018-09-25 23:59:59 +10:00
Marc Chevrier
a71caab46b LINK_DIRECTORIES: Add new properties and commands
These new capabilities enable to manage link directories

Two new properties:
* target properties: LINK_DIRECTORIES and INTERFACE_LINK_DIRECTORIES

One new command
* target_link_directories(): to populate target properties

Fixes: #17215
2018-09-25 23:59:58 +10:00
Craig Scott
2a2f0ac231 Help: Clarify handling of non-integer components in if() version tests 2018-09-17 18:12:08 +08:00