Commit Graph

3075 Commits

Author SHA1 Message Date
Craig Scott dc372f6eef Help: Document Use_wxWindows.cmake as deprecated
The implementation already logged a message saying that the module
was deprecated. This change adds that message to the module docs.
2018-10-09 17:13:52 +02:00
Joachim Wuttke (l) 846e3d2ceb Help: Reorganise module index into sections
* Split up module list into separate sections for utility modules
  and find modules.
* Improve wording to explain how the different module types
  are expected to be called/used.
* Move deprecated modules to their own separate sections.
2018-10-09 17:13:11 +02: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 efa5d5c781 Merge branch 'doc-regex-backslash' into release-3.13
Merge-request: !2460
2018-10-09 06:34:34 -04: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 4422ee3cb2 Merge topic 'add_ctest_progress_docs'
2154ea38f9 Help: Add missing docs for the ctest --progress option
fb2cdf4d4c Help: Use :envvar: links for env vars affecting ctest command

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Michael Wegner <michael.t.wegner@gmail.com>
Merge-request: !2454
2018-10-08 11:26:52 -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 981cdceca2 Merge branch 'add_ctest_progress_docs' into release-3.13
Merge-request: !2454
2018-10-08 11:21:36 -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 2154ea38f9 Help: Add missing docs for the ctest --progress option
These docs were missing from the changes that introduced the feature in
!2240.
2018-10-07 17:03:36 +11:00
Craig Scott fb2cdf4d4c Help: Use :envvar: links for env vars affecting ctest command 2018-10-07 17:03:36 +11:00
Craig Scott cdf8d79e9f Help: Improve/fix incorrect docs for list(SORT) sub-options 2018-10-06 18:10:38 +10:00
Brad King 50f427e022 Merge topic 'doc-find_package-update'
c90f3dff82 Help: Clarify find_package Module and Config mode relation
26dac50220 Help: Remove redundant recommendation
11058a2e7c Help: Add internal section link to find_package command docs
aaf5ea2d70 Help: Add section headers to find_package command
56310b0671 Help: Move find_package NO_POLICY_SCOPE to more appropriate location
336dce1c95 Help: Add table of contents to find_package command docs
463d59d331 Help: Rephrase summary in find_package command docs

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2446
2018-10-05 07:55:57 -04:00
Brad King 3261e18f03 Merge branch 'doc-find_package-update' into release-3.13
Merge-request: !2446
2018-10-05 07:54:27 -04: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
Brad King 10fca3ccc2 Merge topic 'doc-osx-vars-as-cache'
bc57c32d7a Help: Document CMAKE_OSX_* variables as cache entries

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2443
2018-10-04 14:39:16 -04:00
Brad King c4ff696971 Merge branch 'doc-osx-vars-as-cache' into release-3.13
Merge-request: !2443
2018-10-04 14:37:51 -04:00
James Turner bc57c32d7a Help: Document CMAKE_OSX_* variables as cache entries
The variables

* CMAKE_OSX_ARCHITECTURES
* CMAKE_OSX_DEPLOYMENT_TARGET
* CMAKE_OSX_SYSROOT

should be set as cache entries.  Document this explicitly.
2018-10-04 11:23:07 -04:00
Brad King cf57c27150 Merge topic 'pkgc-op-lt-gt'
aa51bfd74f FindPkgConfig: support also > and < operators for version compares

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2435
2018-10-04 10:36:49 -04:00
Brad King a9ff6cefe5 Merge branch 'pkgc-op-lt-gt' into release-3.13
Merge-request: !2435
2018-10-04 10:35:39 -04:00
Rolf Eike Beer aa51bfd74f FindPkgConfig: support also > and < operators for version compares
Fixes: #18416
2018-10-04 10:32:13 -04:00
Brad King a9b442cdc7 Merge branch 'misc-typos' into release-3.13
Merge-request: !2440
2018-10-04 10:13:12 -04:00
Brad King 9de94f10ae Merge branch 'doc-cmp0077' into release-3.13
Merge-request: !2439
2018-10-04 10:13:03 -04:00
Brad King 5161714e1d Merge topic 'misc-typos'
6b4c5a0365 Fix misc. typos

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2440
2018-10-04 10:11:39 -04:00
luz.paz 6b4c5a0365 Fix misc. typos
Found via `codespell -q 3 -I ../cmake-whitelist.txt --skip="./Utilities"`
where the whitelist consists of

```
aci
ans
behaviour
buil
convertor
dum
earch
ect
emmited
emmitted
helpfull
iff
isnt
ith
lowercased
mose
nd
nknown
nto
objext
ot
pathes
pevents
splitted
substract
superceded
supercedes
te
tim
todays
uint
upto
whitespaces
```
2018-10-03 15:32:46 -04:00
Brad King f7722fc939 Help: Drop development topic notes to prepare release
Release versions do not have the development topic section of
the CMake Release Notes index page.
2018-10-03 12:52:15 -04:00
Brad King 53a391561e Help: Clarify policy CMP0077 documentation
Add background about the case in which the policy is relevant.
Describe the OLD and NEW behaviors more completely.

Fixes: #18418
2018-10-03 11:58:22 -04:00
Brad King fd02538974 Merge topic 'doc-3.13-relnotes'
00d96c51c9 Help: Organize and revise 3.13 release notes
2fd2c8cb7e Help: Consolidate 3.13 release notes

Acked-by: Kitware Robot <kwrobot@kitware.com>
Reviewed-by: Marc Chevrier <marc.chevrier@gmail.com>
Reviewed-by: Craig Scott <craig.scott@crascit.com>
Merge-request: !2426
2018-10-03 11:47:15 -04:00
Kyle Edwards fbd89b6753 Help: Add note about CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS 2018-10-01 16:10:33 -04:00
Brad King 00d96c51c9 Help: Organize and revise 3.13 release notes
Add section headers similar to the 3.12 release notes and move each
individual bullet into an appropriate section.  Revise a few bullets.
2018-10-01 10:52:45 -04:00
Brad King 2fd2c8cb7e Help: Consolidate 3.13 release notes
Run the `Utilities/Release/consolidate-relnotes.bash` script to move
notes from `Help/release/dev/*` into `Help/release/3.13.rst`.
2018-10-01 10:21:34 -04:00
Brad King 5cf36d3b0f Merge topic 'byproducts_make_clean'
80e2f8ee0c Ninja,Makefile: Add tests for handling of byproducts by clean operations
c7f1ed03d7 Help: Add release note for make clean and byproducts
4220962d18 Makefile: Add build events byproducts to clean rules
182d9597ec Makefile: Add custom command byproducts to clean rules
9c2b393cb7 Tests: Update CustomCommandWorkingDirectory to handle in-source byproducts

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2334
2018-10-01 09:22:03 -04:00
Brad King 3bb8dda047 Merge topic 'add_progress_summary_console_logging_mode'
b3d5b8b3fb ctest: Add option for live progress summary in terminal
62fbe5002a cmCTestRunTest: Thread number of completed tests through start APIs
02c5091c90 cmCTestRunTest: Simplify number width computation
6a285bb737 cmCTestRunTest: Buffer test result output before printing

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2240
2018-10-01 09:20:44 -04:00
Pedro Navarro c7f1ed03d7 Help: Add release note for make clean and byproducts 2018-09-28 11:30:32 -04:00