summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'doc-link-compile-options'Brad King2021-05-183-6/+15
|\ | | | | | | | | | | | | | | 2eba7d7524 Help: Add SHELL, LINKER and host/device discussions to property docs b20c1f4880 Help: Make SHELL option examples more generic Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6130
| * Help: Add SHELL, LINKER and host/device discussions to property docsCraig Scott2021-05-153-0/+8
| | | | | | | | | | | | Section headings are also added for each common block to help guide the reader and improve navigation. Fixes: #21640
| * Help: Make SHELL option examples more genericCraig Scott2021-05-151-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | Comments at the bottom of the docs for add_compile_options() and target_compile_options() recommend using other commands if setting compiler definitions. Change the examples we use for the SHELL: functionality to use -option instead of -D so that we don't violate our own recommendations. This also makes the examples more appropriate for use with link options as well. Tweak the wording to not specify the type of option being discussed. This will already be clear from the page the text is included into and it avoids naming unrelated option types for the given page.
* | Help: Clarify calling cmake_minimum_required() inside a functionCraig Scott2021-05-151-2/+7
|/ | | Fixes: #21519
* Help: Fix typos and spelling in documentationJosef Angstenberger2021-05-075-6/+6
|
* Merge topic 'generate-cmake-build-command-parallel'Brad King2021-05-052-5/+19
|\ | | | | | | | | | | | | | | | | | | d2b856bc92 ctest_build: Add the PARALLEL_LEVEL argument fc2ac46043 build_command: Add the PARALLEL_LEVEL argument 4dd4e9dd6c cmGlobalGenerator: Add parallel parameter to GenerateCMakeBuildCommand Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Brad King <brad.king@kitware.com> Merge-request: !6069
| * ctest_build: Add the PARALLEL_LEVEL argumentfriendlyanon2021-05-041-0/+8
| | | | | | | | Fixes: #19712
| * build_command: Add the PARALLEL_LEVEL argumentfriendlyanon2021-05-041-5/+11
| | | | | | | | Issue: #19712
* | Merge topic 'doc-tls'Brad King2021-05-051-1/+1
|\ \ | | | | | | | | | | | | | | | | | | 7398993f5b Help: Document CMAKE_TLS_VERIFY variable explicitly Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6064
| * | Help: Document CMAKE_TLS_VERIFY variable explicitlyMichael Hirsch2021-05-041-1/+1
| |/ | | | | | | | | Previously it was mentioned only in the `file` and `ExternalProject` documentation.
* | foreach(): loop variables are only available in the loop scopeMarc Chevrier2021-04-281-1/+4
|/ | | | Fixes: #20553
* Help: Document CTest custom test measurementsZack Galbreath2021-04-271-0/+80
|
* Merge topic 'ctest_junit'Brad King2021-04-271-0/+10
|\ | | | | | | | | | | | | | | | | | | | | 25bf514447 ctest: Add support for writing test results in JUnit XML format Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Zack Galbreath <zack.galbreath@kitware.com> Acked-by: Michael Hirsch <michael@scivision.dev> Acked-by: MvdHurk <maikelvandenhurk@hotmail.com> Acked-by: Alexander Richardson <arichardson.kde@gmail.com> Merge-request: !6020
| * ctest: Add support for writing test results in JUnit XML formatZack Galbreath2021-04-261-0/+10
| | | | | | | | Addresses #18654
* | Merge topic 'file-REAL_PATH-EXPAND_TILDE'Brad King2021-04-262-6/+17
|\ \ | |/ |/| | | | | | | | | | | e4b793c614 file(REAL_PATH): add option EXPAND_TILDE Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Michael Hirsch <michael@scivision.dev> Merge-request: !6033
| * file(REAL_PATH): add option EXPAND_TILDEMarc Chevrier2021-04-212-6/+17
| | | | | | | | | | This option enables the replacement of any leading tilde with the path to the user's home directory.
* | Help: cmake_minimum_required specify max is only for policiesRobert Maynard2021-04-201-6/+8
|/ | | | | | Make it even clearer that for the signature `<version>...<version>` that the second value is only used for policies, and is not a clamp range of supported CMake versions.
* Merge topic 'Xcode-add_custom_command-DEPFILE'Brad King2021-04-201-8/+0
|\ | | | | | | | | | | | | 253aff6c94 Xcode: Add support of DEPFILE for add_custom_command, part 2 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6015
| * Xcode: Add support of DEPFILE for add_custom_command, part 2Marc Chevrier2021-04-171-8/+0
| | | | | | | | | | | | This MR extend the support of 'DEPFILE' to buildsystem version 1. Issue: #20286
* | Merge topic 'doc-if-IS_ABSOLUTE'Brad King2021-04-202-2/+12
|\ \ | |/ |/| | | | | | | | | | | 6234afdff4 Help: Document special cases for if(IS_ABSOLUTE) 789307b02f Help: Behavior of file(TO_NATIVE_PATH) depends on the host platform Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6016
| * Help: Document special cases for if(IS_ABSOLUTE)Craig Scott2021-04-171-1/+10
| | | | | | | | | | | | | | The meaning of "absolute path" was previously assumed knowledge, but a number of special cases were left unspecified. The way some of these are handled differs to the way that cmake_path(IS_ABSOLUTE) works, so document those special cases so that the differing behavior between these two commands is clearly defined.
| * Help: Behavior of file(TO_NATIVE_PATH) depends on the host platformCraig Scott2021-04-171-1/+2
| |
* | Xcode: Add support of DEPFILE for add_custom_commandMarc Chevrier2021-04-151-10/+20
| | | | | | | | Issue: #20286
* | Genex: add_custom_command: DEPFILE supports genexMarc Chevrier2021-04-121-1/+6
| | | | | | | | | | | | This facility is very useful for 'Ninja Multi-Config' and required as well for future support of DEPFILE in 'Xcode' and 'Visual Studio' generators (#20286).
* | Merge topic 'doc-imported-soname'Brad King2021-04-051-6/+18
|\ \ | |/ | | | | | | | | | | 4d6e899578 Help: Document in add_library how to import libraries with SONAME Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5975
| * Help: Document in add_library how to import libraries with SONAMEBrad King2021-04-021-6/+18
| | | | | | | | | | | | | | | | | | | | When using `add_library` to create an `IMPORTED` library target, there are a few target properties that are essential to correctly tell CMake about the library file. We already cover `IMPORTED_LOCATION` and `IMPORTED_IMPLIB`. Add `IMPORTED_SONAME` and `IMPORTED_NO_SONAME`, which are important in certain cases. Fixes: #22016
| * Merge topic 'commands-file-permissions' into release-3.20Brad King2021-03-292-23/+40
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | 769ff05483 Help: Clarify permission-related command options 900184616a Cleanup: Fix misspelt name of local C++ variable 635431a0c9 Tests: Check host platform instead of target for running stat 4ceb0ca59e Tests: Remove redundant files for configure_file() tests Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5945
* | \ Merge topic 'commands-file-permissions'Brad King2021-03-292-23/+40
|\ \ \ | | |/ | |/| | | | | | | | | | | | | | | | | | | | | | 769ff05483 Help: Clarify permission-related command options 900184616a Cleanup: Fix misspelt name of local C++ variable 635431a0c9 Tests: Check host platform instead of target for running stat 4ceb0ca59e Tests: Remove redundant files for configure_file() tests Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5945
| * | Help: Clarify permission-related command optionsCraig Scott2021-03-262-23/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The previous docs did not make clear that at most only one of the three permissions-related options can be given for configure_file() or file(GENERATE) and that USE_SOURCE_PERMISSIONS is already the default behavior for these commands. Use consistent wording to refer to the input and output files for configure_file(). Add missing "versionadded" directives on some of these keywords. Use the consistent wording and keyword ordering between the configure_file(), file(GENERATE) and file(COPY) commands.
* | | project: Define variables indicating whether project is top levelfriendlyanon2021-03-261-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | Define `PROJECT_IS_TOP_LEVEL` and `<PROJECT-NAME>_IS_TOP_LEVEL`. The latter is a STATIC cache entry just like other `<PROJECT-NAME>_*` variables so that it is globally scoped. Issue: #20310 Fixes: #21961
* | | Help: Convert project() directory variables to a definition listBrad King2021-03-261-5/+6
| | |
* | | Merge topic 'doc-custom-output-genex'Brad King2021-03-252-3/+9
|\ \ \ | | |/ | |/| | | | | | | | | | | | | 2f59b683d3 Help: Custom OUTPUT and BYPRODUCTS genexes cannot refer to targets Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5939
| * | Help: Custom OUTPUT and BYPRODUCTS genexes cannot refer to targetsCraig Scott2021-03-252-3/+9
| |/ | | | | Relates: #21364
* | Help: Clarify configure_file #cmakedefine01 syntax and behaviorElsie Hupp2021-03-151-2/+24
| | | | | | | | Fixes: #21935
* | file: add `COPY_FILE` subcommandBen Boeckel2021-03-101-0/+23
| | | | | | | | | | | | The `file(COPY)` subcommand is overloaded and busy for such a simple operation. Instead, make a simpler subcommand with error handling support.
* | Find: Document that first argument to PATHS and HINTS can be ENV{}Robert Maynard2021-03-051-2/+2
| |
* | file(RENAME): Add option to not replace existing pathBrad King2021-03-041-1/+7
| | | | | | | | | | Add a `NO_REPLACE` option that prevents overwriting `<newname>` if it exists.
* | file(RENAME): Add option to capture error message on failureBrad King2021-03-041-2/+9
|/
* Help: Add internal links to if() docsMichael Hirsch, Ph.D2021-02-181-7/+51
|
* Help: Convert some genex names to explicit cross-referencesBrad King2021-02-053-6/+6
| | | | | | | | | Since commit c2dc7e0f53 (Help: Convert genex documentation to sphinx domain objects, 2021-01-15) we can use `:genex:` cross-references to link to named generator expressions. Update some places to do this. This is meant to demonstrate the capability, not as a comprehensive sweep.
* Merge topic 'doc-find-env-vars'Brad King2021-02-053-3/+6
|\ | | | | | | | | | | | | c40e81ce80 Help: Restore docs that find_library considers LIB, not INCLUDE Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5772
| * Help: Restore docs that find_library considers LIB, not INCLUDEBrad King2021-02-043-3/+6
| | | | | | | | | | | | | | | | | | | | Documentation updates in commit 02f527c66a (Find: Provide global controls for the `NO_[]_PATH` call options, 2019-06-12, v3.16.0-rc1~541^2) accidentally switched the `find_library` documentation to mention `INCLUDE` where it should be `LIB`. While at it, update `find_file` and `find_path` to mention `INCLUDE` and `PATH` in the order they are considered.
* | try_run: Allow to set working directoryAsit Dhal2021-02-031-0/+7
| | | | | | | | Fixes: #17634
* | Merge topic 'issue-19198'Brad King2021-02-021-1/+9
|\ \ | | | | | | | | | | | | | | | | | | | | | 255df8622b file(GENERATE): Support new line style Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Brad King <brad.king@kitware.com> Merge-request: !5649
| * | file(GENERATE): Support new line styleAsit Dhal2021-02-011-1/+9
| | | | | | | | | | | | Fixes: #19198
* | | Added `SETUID` and `SETGID` to the list of accepted file permissionswilliam.r.dieter2021-01-291-1/+1
|/ / | | | | | | Signed-off-by: william.r.dieter <william.r.dieter@intel.com>
* | cmake_path: rename 'GET ... RELATIVE_PATH' to 'GET ... RELATIVE_PART'Marc Chevrier2021-01-281-70/+49
| | | | | | | | | | | | | | For consistency, subcommand 'HAS_RELATIVE_PATH' is also renamed to 'HAS_RELATIVE_PART'. Fixes: #21385
* | Help: Document that if(EXISTS) does not expand ~Michael Hirsch, Ph.D2021-01-261-3/+4
| | | | | | | | Fixes: #21729
* | Help: Restructure and clarify cmake_path() docsCraig Scott2021-01-161-534/+523
| | | | | | Relates: #21385
* | Merge topic 'cmake_path-stabilization'Marc Chevrier2021-01-151-4/+3
|\ \ | | | | | | | | | | | | | | | | | | 76f0bcdfb6 cmake_path: various updates Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5695