summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* 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
| * 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.
* | Help: Custom OUTPUT and BYPRODUCTS genexes cannot refer to targetsCraig Scott2021-03-252-3/+9
|/ | | Relates: #21364
* 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
| * | cmake_path: various updatesMarc Chevrier2021-01-131-4/+3
| | | | | | | | | | | | | | | | | | To follow discussions in #21385 and !5682: * Fix bug in cmCMakePath::IsSuffix() method * cmake_path(HASH) always normalized paths (NORMALIZE option removed)
* | | install(files): Support genex in rename optionAsit Dhal2021-01-131-0/+5
|/ / | | | | | | Fixes: #19903
* | Help: Add sections to if() conditions documentationShannon Booth2021-01-081-19/+35
| |
* | Makefiles: Add support of DEPFILE for add_custom_commandMarc Chevrier2020-12-231-3/+18
| | | | | | | | | | Issue: #20286 Fixes: #21415
* | Merge topic 'issue-20134'Brad King2020-12-221-3/+3
|\ \ | | | | | | | | | | | | | | | | | | b68699b717 target_include_directories: Support AFTER option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5633
| * | target_include_directories: Support AFTER optionAsit Dhal2020-12-191-3/+3
| | | | | | | | | | | | Fixes: #20134
* | | Merge topic 'issue-15653'Brad King2020-12-221-1/+14
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | c3385dd8bd file(GENERATE): Support options to manipulate file permissions Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5437
| * | | file(GENERATE): Support options to manipulate file permissionsAsit Dhal2020-12-211-1/+14
| |/ / | | | | | | | | | Fixes: #15653
* | | Help: replace deprecated $<CONFIGURATION> generator expressionNeroBurner2020-12-211-1/+1
|/ / | | | | | | | | The `$<CONFIGURATION>` genex has been deprecated since CMake 3.0. Use `$<CONFIG>` instead in the `add_test` example.
* | Ninja Multi-Config: Add support for cross-config custom commandsKyle Edwards2020-12-152-0/+18
| | | | | | | | Co-Author: Brad King <brad.king@kitware.com>
* | Help: Clarify version adding add_custom_{command,target} OUTPUT genex supportBrad King2020-12-152-34/+39
| | | | | | | | | | | | | | Update the documentation added by commit c257c25419 (add_custom_{command,target}: Add genex support to OUTPUT and BYPRODUCTS, 2020-10-19) to use sphinx markup instead of prose to specify the version in which the feature was added.
* | Merge topic 'custom-command-output-genex'Brad King2020-12-142-0/+89
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | c257c25419 add_custom_{command,target}: Add genex support to OUTPUT and BYPRODUCTS f36af9228b cmLocalGenerator: Evaluate generator expressions in custom command outputs c887cefd9a cmLocalGenerator: Simplify custom command output cmSourceFile creation 947ba01bf9 cmLocalGenerator: Factor out helper to expand custom command output paths 1902d28ebc cmLocalGenerator: Refactor UpdateOutputToSourceMap to avoid boolean trap e4034eabe9 cmLocalGenerator: Re-order logic in CreateGeneratedSource 706c48301d cmCustomCommandGenerator: Treat relative outputs w.r.t. build dir 5d23c5446e cmCustomCommandGenerator: Refactor OUTPUT and DEPENDS path evaluation ... Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Kyle Edwards <kyle.edwards@kitware.com> Acked-by: Pavel Solodovnikov <hellyeahdominate@gmail.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !5402
| * | add_custom_{command,target}: Add genex support to OUTPUT and BYPRODUCTSBrad King2020-12-112-0/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | Move rejection of `#`, `<`, and `>` characters in outputs and byproducts to a generate-time check. This removes the front-end check that disallowed generator expressions. The generators have already been updated to handle them. Fixes: #12877
| * | Help: Add examples to add_custom_command reference documentationBrad King2020-12-101-0/+38
| | |
* | | Merge branch 'master' into doc-3_19_release-fixesBrad King2020-12-1160-437/+1825
|\ \ \ | |/ / | | / | |/ |/|
| * Help: Fix grammar in `.. versionadded` directivesNikita Nemkin2020-12-028-16/+17
| | | | | | | | Issue: #19715
| * Help: Fix version note for CMAKE_PROJECT_<PROJECT-NAME>_INCLUDENikita Nemkin2020-12-021-2/+3
| | | | | | | | | | | | This variable predates 3.0. Fixes: #21522
| * Help: Fix cmake_parse_arguments version noteNikita Nemkin2020-12-021-2/+4
| | | | | | | | Don't imply that cmake_parse_arguments() requires CMake 3.5+.
| * Merge topic 'compile_def_doc'Brad King2020-12-011-0/+9
| |\ | | | | | | | | | | | | | | | | | | 4b9fcadc9a Help: Describe definition values in target_compile_definitions Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5547
| | * Help: Describe definition values in target_compile_definitionsJuan Ramos2020-11-301-0/+9
| | | | | | | | | | | | Fixes: #20573
| * | GENERATED prop: Introducing policy CMP0118 and its documentationDeniz Bahadir2020-11-244-0/+20
| |/ | | | | | | | | Note: This is currently only defining the CMP0118 policy and providing its documentation, however, the implementation is still not using it.
| * Merge topic 'cmake_path-enhancements'Craig Scott2020-11-141-74/+58
| |\ | | | | | | | | | | | | | | | | | | ed21ad181e cmake_path: various enhancements to subcommands/keywords Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5457
| | * cmake_path: various enhancements to subcommands/keywordsMarc Chevrier2020-11-111-74/+58
| | | | | | | | | | | | This change address partly the remarks done in issue #21385
| * | Help: Replace some `versionadded` directives with `versionchanged`Nikita Nemkin2020-11-1213-19/+19
| |/ | | | | | | | | | | | | | | `.. versionchanged` directive might be more appropriate when documentation refers to previous CMake version, old behavior or a policy, and there's no new parameter or a variable involved. Issue: #19715
| * Merge topic 'get_filename_component-clarification'Brad King2020-11-111-2/+2
| |\ | | | | | | | | | | | | | | | | | | c0e05671d3 Help/get_filename_component: clarify NAME_W[L]E summaries Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5489
| * | Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-0958-434/+939
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
| * | Merge topic 'string-json-doc-update'Craig Scott2020-10-301-10/+13
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | 49fce3373b Help: Clarify string(JSON) error handling Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5427
| * \ \ Merge topic 'cmake_path-update-doc'Brad King2020-10-281-122/+127
| |\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ec5951e078 cmake_path: Enhance documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5425
| * \ \ \ Merge topic 'cmake-20866'Brad King2020-10-271-1/+8
| |\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 03ad0e61c1 configure_file: Add option for user defined permissions Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5320
| | * | | | configure_file: Add option for user defined permissionsAsit Dhal2020-10-241-1/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | User defined permissions and options to copy permissions are implemented. Fixes: #20866
| * | | | | Merge topic 'issue-21034'Brad King2020-10-271-2/+4
| |\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1a3d125de8 target_sources: Support custom targets Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5421
| | * | | | | target_sources: Support custom targetsAsit Dhal2020-10-241-2/+4
| | |/ / / / | | | | | | | | | | | | | | | | | | Fixes: #21034
| * | | | | Merge topic 'docs-cleanup-3.19'Craig Scott2020-10-267-45/+57
| |\ \ \ \ \ | | |/ / / / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | 95c14579f2 Help: Cleanup typos and grammar for the 3.19 release Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5419
| * | | | | Help: Document site_name command use of HOSTNAME variableBrad King2020-10-221-0/+4
| | | | | |
generated by cgit v0.12 at 2025-02-02 04:43:22 (GMT)