Commit Graph

833 Commits

Author SHA1 Message Date
Brad King
ee781ac59d Merge topic 'doc-versionadded'
496ec6036f Help: Add Sphinx 'versionadded' directives to each top-level document
0c87afceab Help/dev: Add maintainer guide step for 'versionadded' documentation markup
dbd453c2ff Utilities/Sphinx: Add script for inserting ".. versionadded" directive

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Alex Turbov <i.zaufi@gmail.com>
Merge-request: !4947
2020-07-07 09:22:28 -04:00
Kitware Robot
496ec6036f Help: Add Sphinx 'versionadded' directives to each top-level document
Run the `Utilities/Sphinx/update_versions.py` script to add initial
markup to every top-level document and find module.

Issue: #19715
2020-07-06 10:23:20 -04:00
Brad King
9e1cd8ea45 Merge topic 'doc-file_ARCHIVE_synopsis'
f9766dad19 Help: Update file(ARCHIVE...) synopsis for renamed options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4977
2020-07-06 09:24:48 -04:00
Craig Scott
f9766dad19 Help: Update file(ARCHIVE...) synopsis for renamed options
The FILES and DIRECTORY options were renamed in bbcff21f71
(file(ARCHIVE*): Collapse FILES and DIRECTORY options, 2020-06-30), 
but the synopsis part of the file() documentation was missed.
The synopsis also typically only shows the mandatory options.
Update the synopsis to reflect the name changes and omit the
DESTINATION option since it is not mandatory.
2020-07-06 20:15:09 +10:00
Brad King
b7af2811ae Merge topic 'configure_file-permission-control'
27b03281e2 configure_file: Add option to control file permissions transfer to copy

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4941
2020-07-01 07:03:03 -04:00
Brad King
0ca6bb8575 Merge topic 'file-ARCHIVE-files-dirs' into release-3.18
bbcff21f71 file(ARCHIVE*): Collapse FILES and DIRECTORY options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4955
2020-07-01 07:00:42 -04:00
Brad King
9c3e9881ef Merge topic 'file-ARCHIVE-files-dirs'
bbcff21f71 file(ARCHIVE*): Collapse FILES and DIRECTORY options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4955
2020-07-01 07:00:42 -04:00
Rahul Gottipati
27b03281e2 configure_file: Add option to control file permissions transfer to copy
Issue: #20866
2020-06-30 11:20:41 -04:00
Brad King
221fd89251 Merge topic 'file-CONFIGURE-subdir' into release-3.18
e5f5eeca2f file: Fix CONFIGURE output relative path

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4951
2020-06-30 08:04:07 -04:00
Brad King
947a518716 Merge topic 'file-CONFIGURE-subdir'
e5f5eeca2f file: Fix CONFIGURE output relative path

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4951
2020-06-30 08:04:07 -04:00
Craig Scott
bbcff21f71 file(ARCHIVE*): Collapse FILES and DIRECTORY options
The two options were concatenated internally for both ARCHIVE_CREATE
and ARCHIVE_EXTRACT. The distinction between files and dirs was not
meaningful. Therefore, replace them with PATHS or PATTERNS 
to more accurately describe the way the options are used.

Fixes: #20884
2020-06-30 22:01:35 +10:00
Brad King
e5f5eeca2f file: Fix CONFIGURE output relative path
In commit a6fee09484 (file: Add CONFIGURE subcommand, 2020-03-06,
v3.18.0-rc1~584^2) we accidentally treated relative path outputs
with respect to the current working directory.  Treat them with
respect to the current binary directory instead.

Fixes: #20885
2020-06-29 09:20:42 -04:00
Craig Scott
95159b7dea file(ARCHIVE_CREATE): Rename TYPE option to COMPRESSION
Fixes: #20883
2020-06-27 18:38:28 +10:00
Craig Scott
bc45bdc819 Help: Fix contents indenting for file(ARCHIVE_...) subcommands 2020-06-27 16:33:29 +10:00
Brad King
1f47a65c7a Merge topic 'doc-get_target_property' into release-3.18
f4b911a2c9 Help: Update docs for failure result of get_target_property

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4933
2020-06-23 08:50:54 -04:00
Christopher Tetreault
f4b911a2c9 Help: Update docs for failure result of get_target_property
If `get_target_property` fails to find a value for a non-inherited
property, it appends `-NOTFOUND` to the var name and sets that as the
result, rather than setting the value of the var to `NOTFOUND`.
2020-06-23 08:17:59 -04:00
Robert Maynard
e5279c2c8f Help: Better document that CMP0105 controls DEVICE_LINK parsing 2020-06-18 12:07:26 -04:00
Brad King
35a192788f Merge topic 'doc-EXCLUDE_FROM_ALL'
e262123fee Help: Clarify the effect of EXCLUDE_FROM_ALL on target installation
a09195e7bf Help: Rename 'artefact' to 'artifact' in target_precompile_headers

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4840
2020-06-03 07:48:13 -04:00
Arcturus
a09195e7bf Help: Rename 'artefact' to 'artifact' in target_precompile_headers 2020-06-02 13:26:38 -04:00
Marc Chevrier
056489d567 add_library/add_executable: allow local alias to imported targets
Fixes: #20641
2020-06-02 17:11:47 +02:00
Marc Chevrier
254f2b9058 Help: add_executable: Add TOC 2020-06-02 15:37:21 +02:00
Brad King
3a9b257ee7 Merge topic 'cmake_language-check-invalid-commands'
12e483c563 cmake_language: check CALL with control command

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4788
2020-05-27 08:17:49 -04:00
Marc Chevrier
12e483c563 cmake_language: check CALL with control command
Fixes: #20739
2020-05-26 07:27:35 -04:00
Brad King
3a1853b9fd Merge topic 'doc-updates'
b3e4fb5144 Help: clarify add_definitions() and add_compile_definitions() behavior

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4786
2020-05-25 15:50:18 -04:00
Marc Chevrier
b3e4fb5144 Help: clarify add_definitions() and add_compile_definitions() behavior
Fixes: #20736
2020-05-24 12:47:24 +02:00
Craig Scott
1b0049680b Merge topic 'cmake_language-rename-from-cmake_command'
94c1e4fdb3 cmake_language: Rename command from cmake_command

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4774
2020-05-22 10:25:29 -04:00
Brad King
d8eee80e30 Merge branch 'backport-cuda-default-runtime' into cuda-default-runtime 2020-05-22 06:50:19 -04:00
Brad King
94c1e4fdb3 cmake_language: Rename command from cmake_command
Also rename the `INVOKE` signature to `CALL`.

Fixes: #20732
2020-05-21 13:36:52 -04:00
Robert Maynard
1086e930dc CUDA: Propagate CMAKE_CUDA_RUNTIME_LIBRARY state to try_compile 2020-05-20 14:36:55 -04:00
Craig Scott
bc735062df Help: Improve formatting and cross-references for find_package() 2020-05-20 20:54:55 +10:00
Craig Scott
ddcc5a350c Merge topic 'doc-CMAKE_SYSTEM_PREFIX_PATH'
6b3d8f281e Document which environment variables effect CMAKE_SYSTEM_PREFIX_PATH

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4748
2020-05-20 06:28:11 -04:00
Robert Maynard
6b3d8f281e Document which environment variables effect CMAKE_SYSTEM_PREFIX_PATH 2020-05-19 10:57:09 -04:00
Brad King
80e93984c7 Merge topic 'add_test-special-chars-in-name'
f84af8e270 add_test: Allow special characters in test name

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4754
2020-05-19 09:48:38 -04:00
Brad King
4acf31d681 Merge topic 'compile_opts'
448e2d7a9d Help: Provide cross-references between compiler settings
1f697b3991 Help: COMPILE_OPTIONS: bundle cross refs, add example

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4749
2020-05-18 12:27:31 -04:00
Deniz Bahadir
f84af8e270 add_test: Allow special characters in test name
Fixes: #19391
2020-05-17 10:53:14 +02:00
Joachim Wuttke (h)
448e2d7a9d Help: Provide cross-references between compiler settings 2020-05-14 22:17:10 +02:00
Alexandru Croitor
3d4b70ea64 set_source_files_properties: Allow specification of directory scope
Both set_source_files_properties() and set_property(SOURCE) now accept
two new optional arguments: DIRECTORY and TARGET_DIRECTORY.

The DIRECTORY option takes a list of relative or absolute paths
pointing to processed source directories (add_subdirectory was
already called on them).

These paths specify directory scopes where the source file properties
will be set. Previously the scope was always the currently processed
source directory.

Similarly TARGET_DIRECTORY takes a list of targets, whose source
directories will be used as the list of scopes where to set the
source file properties.

get_property() and get_source_file_property() also get the same
new arguments, except only one value can be specified instead
of a list.

Fixes: #20128
2020-05-14 16:31:22 +02:00
Craig Scott
faf44a8cdb source_group: Support forward slashes in group hierarchy
Fixes: #18076
2020-05-11 08:15:25 +10:00
Hong Xu
36a6d91011 Help: If a cache variable exists, option() also does nothing
The previous text sounded as if option() does some work when a
cache variable exists.
2020-05-08 18:30:27 +10:00
Brad King
25cbd22afb Merge topic 'pch-genex-absolute'
b204bae261 target_precompile_headers: Fix documented example using genex

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Cristian Adam <cristian.adam@gmail.com>
Merge-request: !4678
2020-04-28 07:09:01 -04:00
Brad King
41d37e45e9 Merge topic 'pch-genex-absolute' into release-3.17
b204bae261 target_precompile_headers: Fix documented example using genex

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Cristian Adam <cristian.adam@gmail.com>
Merge-request: !4678
2020-04-28 07:09:00 -04:00
Brad King
b204bae261 target_precompile_headers: Fix documented example using genex
When the path to a header file is specified using a generator
expression, evaluation of the genex must produce an absolute path.
Update our documented example and add a test covering the case.

Fixes: #20617
2020-04-27 14:12:41 -04:00
Brad King
0315d269c2 Help: Reference policy CMP0082 from install() command docs
The policy plays an important role in the behavior of the `install()`
command, so the latter's documentation should mention it.
2020-04-27 07:45:11 -04:00
Jaak Ristioja
c6872432e6 Help: Fixed typo in command/separate_arguments.rst 2020-04-22 23:21:51 +03:00
Brad King
f9fbc78cd6 Merge topic 'ctest_stop_on_failure_16628'
e89aeba5c4 ctest: add option --stop-on-failure

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4630
2020-04-22 08:38:33 -04:00
Johnny Jazeix
e89aeba5c4 ctest: add option --stop-on-failure
To stop the tests once one has failed

Fixes: #16628
2020-04-20 23:05:15 +02:00
Marc Chevrier
4248bb452a CUDA: Device linking use now link options
properties LINK_OPTIONS and INTERFACE_LINK_OPTIONS are propagated
to the device link step.

To control which options are selected for normal link and device link steps,
the $<DEVICE_LINK> and $<HOST_LINK> generator expressions can be used.

Fixes: #18265
2020-04-19 15:53:11 +02:00
Brad King
ad937fb36c Help: Document that set_property APPEND ignores empty values
Fixes: #20581
2020-04-17 08:09:06 -04:00
Brad King
ad386d42d7 Merge topic 'doc-CMAKE_PREFIX_PATH-env-var'
d59c6ea5c6 Help: Convert find_package references to CMAKE_PREFIX_PATH to links
03b6f3a2e8 Help: Document the CMAKE_PREFIX_PATH environment variable

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4609
2020-04-15 09:47:36 -04:00
Brad King
d59c6ea5c6 Help: Convert find_package references to CMAKE_PREFIX_PATH to links 2020-04-14 10:08:23 -04:00