summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* FILE_SET: Make INTERFACE libraries with HEADER_SETS participate in buildsystemKyle Edwards2022-04-141-0/+1
| | | | | | | | If an INTERFACE library has HEADER_SETS, and its header sets contain files generated by a custom command, the library needs to participate in the buildsystem so that the files will be generated. Fixes: #23422
* FILE_SET: Forbid adding header sets to Apple FRAMEWORK librariesKyle Edwards2022-04-071-1/+1
| | | | | | | | The feature needs a specialized implementation to place headers in the right place inside frameworks. To avoid silently doing the wrong thing, make this case an error for the 3.23 series. Issue: #23386
* Help: Fix typo in install command documentationEugene Shalygin2022-04-031-1/+1
|
* Help: Fix string(JSON ... LENGTH ...) signatureTobias Nießen2022-03-301-1/+1
| | | | | The list of indices and/or member names is optional, i.e., can be empty. For example, string(JSON foo LENGTH "[0,0,0]") sets foo to 3.
* define_property(): Change constraints of INITIALIZE_FROM_VARIABLEKyle Edwards2022-03-231-2/+4
| | | | | | | Remove the requirement that the variable name have a prefix while keeping the suffix requirement. Require that the property name contains an underscore. Update docs and tests accordingly. Fixes: #23340
* Merge topic 'cleanup-define_property' into release-3.23Brad King2022-03-221-11/+15
|\ | | | | | | | | | | | | | | | | | | | | 87c3b5e421 define_property(): Only test prefix if INITIALIZE_FROM_VARIABLE is given 9b50f221f6 Help: Update the main purpose of define_property() e993e2c52c Help: Clean up INITIALIZE_FROM_VARIABLE define_property() option Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Acked-by: Kyle Edwards <kyle.edwards@kitware.com> Merge-request: !7090
| * Help: Update the main purpose of define_property()Craig Scott2022-03-191-7/+9
| | | | | | | | | | | | | | | | | | | | | | The BRIEF_DOCS and FULL_DOCS are remnants from before the Sphinx-based documentation when CMake's internal structures for defining properties included fields for their documentation. They are no longer mandatory for define_property() and haven't been in practical use for some time. The main use of the command has evolved to now be more about how to initialize and inherit properties, so update the docs to reflect that change in focus. Issue: #20698
| * Help: Clean up INITIALIZE_FROM_VARIABLE define_property() optionCraig Scott2022-03-191-4/+6
| | | | | | | | | | | | | | | | | | INITIALIZE_FROM_VARIABLE is new in CMake 3.23, but the versionadded note was missing in the original commit. The docs also failed to mention that the new option only applies to target properties. Amends fce24e4f10 (define_property(): Add INITIALIZE_FROM_VARIABLE argument, 2022-01-13)
* | Help: Clarify when add_test and test properties support generator expressionsBrad King2022-03-213-8/+26
|/ | | | Issue: #23329
* Help: Clarify behavior of search ignore-related variablesCraig Scott2022-03-132-0/+10
| | | | | | | | | | | Not all the behaviors of CMake variables for ignoring search locations by find_...() commands were fully documented. Add the missing effects, clarify the wording and restructure the way the details are assembled to reduce duplication. Also improve the cross-referencing to ensure all the related variables are more discoverable. Issue: #20878
* Help: Update install() docs to better reflect preference for file setsCraig Scott2022-03-081-21/+39
| | | | | | | Previously, headers would typically be installed as bare files or as whole directories. File sets offer a better abstraction and associate headers with a target, installing them as part of the target. Add notes and update examples to draw the reader's attention to the advantages of file sets for headers.
* Help: Reorganise FILE_SETS and related propertiesCraig Scott2022-03-051-55/+41
| | | | | | | | | | | | Reduce duplication and make the docs for target_sources() focus on the functionality rather than the properties it modifies. The properties are a lower level quantity, so put the relevant details for them in the property documentation. The target_sources() command only needs to reference the properties, not reproduce the property documentation. Improve the cross-referencing between the HEADER_... property docs. This helps build the mental picture of how they relate to each other.
* Merge topic 'file-set-name-requirements' into release-3.23Brad King2022-03-041-1/+2
|\ | | | | | | | | | | | | | | b357d334fc target_sources(): Enforce stricter requirements for FILE_SET name Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !7037
| * target_sources(): Enforce stricter requirements for FILE_SET nameKyle Edwards2022-03-031-1/+2
| | | | | | | | Fixes: #23286
* | target_sources(): Process multiple FILE_SET arguments per blockKyle Edwards2022-03-031-2/+3
|/ | | | Fixes: #23287
* target_sources(): Prohibit FILE_SET on custom targetsKyle Edwards2022-02-281-1/+2
| | | | Fixes: #23262
* Help: Organize and clarify export() command documentationBrad King2022-02-141-43/+88
| | | | | | | | | Add section headers for each signature, and a synopsis linking to them. Re-order sections to introduce the main `export(TARGETS)` functionality before mentioning the `export(EXPORT)` shorthand, which may be confused with `install(EXPORT)`. Fixes: #23221
* Help: Clarify precedence of AND and OR in 'if' conditionsBrad King2022-02-091-8/+15
| | | | | | | | | | | | The wording update in commit b74819e4fe (Help: Format 'if' command documentation, 2013-12-18, v3.0.0-rc1~227^2~1) incorrectly implied that `AND` has higher precedence than `OR`. Although this is common in many languages, it has never been true in CMake's implementation. Revise the wording to clarify the precedence. Add a test case demonstrating the order. Fixes: #23207
* Help: Clarify documentation on SYSTEM include directoriesBrad King2022-02-031-6/+9
| | | | | | | | Mention that system include directories are searched after normal include directories. Document that `IMPORTED_NO_SYSTEM` and `NO_SYSTEM_FROM_IMPORTED` do not affect `INTERFACE_SYSTEM_INCLUDE_DIRECTORIES`.
* Merge topic 'help-try-compile-result-var'Brad King2022-02-012-13/+0
|\ | | | | | | | | | | | | 34d263270e Help: Drop incorrect versionadded for try_compile result variable Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6923
| * Help: Drop incorrect versionadded for try_compile result variablefriendlyanon2022-01-312-13/+0
| | | | | | | | | | | | | | | | | | | | | | | | In commit c705279bae (Help: Add `.. versionadded` directives to commands documentation, 2020-11-08, v3.20.0-rc1~508^2) we accidentally added ``versionadded`` markup suggesting that the first argument to `try_compile` was fixed as `RESULT_VAR` prior to CMake 3.14. This was probably due to misinterpreting the change from commit 7975edeac5 (Help: User-provided variable names for try_* commands, 2019-02-24, v3.14.0-rc3~16^2~3). The result variable has never been fixed. Drop the incorrect markup.
| * Help: cmake_path: fix erroneous example for IS_PREFIXMarc Chevrier2021-06-121-3/+4
| |
* | Help: Clarify relative path handling for target_include_directories()Craig Scott2022-01-311-8/+17
| | | | | | Fixes: #22853
* | string(TIMESTAMP): add %f specifier for microsecondsPeter Würth2022-01-281-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The %f specified extends the string(TIMESTAMP) and file(TIMESTAMP) commands to output the timestamp with a microsecond resolution. This convention is offered by python's datetime module. Before, the precision was limited to seconds. The implementation is done by extending existing cmTimestamp methods with a `microseconds` parameter. This parameter is optional in order to be backwards compatible. The timestamps are now received in a cross-platform manner using libuv, since the standard C functions like time() don't allow for sub-second precision. This requires libuv 1.28 or higher. We already require higher than that on Windows, so update the required version for other platforms. Implements: #19335
* | Help: Note the version in which define_property() arguments became optionalKyle Edwards2022-01-211-0/+4
| |
* | define_property(): Add INITIALIZE_FROM_VARIABLE argumentKyle Edwards2022-01-201-1/+7
| | | | | | | | Fixes: #20698
* | Merge topic 'define-property-optional-args'Brad King2022-01-191-2/+2
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | edb5059216 define_property(): Make BRIEF_DOCS and FULL_DOCS optional 7d26baff46 cmDefinePropertyCommand: Refactor to use cmArgumentParser Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !6875
| * | define_property(): Make BRIEF_DOCS and FULL_DOCS optionalKyle Edwards2022-01-181-2/+2
| | | | | | | | | | | | Issue: #20698
* | | Depfile parsing: enhance compatibility with GNU MakeMarc Chevrier2022-01-161-4/+3
|/ /
* | Help: add_custom_command: describes depfile formatMarc Chevrier2022-01-111-3/+42
| |
* | Help: Non-zero floating point numbers are true in if() expressionsCraig Scott2022-01-031-1/+2
| | | | | | Fixes: #22991
* | Help: mention non-existent case for list(PREPEND)Adriaan de Groot2021-12-211-1/+3
| |
* | Help: clarify range for list(INSERT), mention nonexistent / empty caseAdriaan de Groot2021-12-211-1/+6
| |
* | Help: clarify description of list(INSERT)Adriaan de Groot2021-12-211-1/+1
| | | | | | | | Since the argument is called 'index', use that in the description.
* | Help: clarify that list(APPEND) on a non-existent list creates itAdriaan de Groot2021-12-211-1/+3
| | | | | | | | | | | | | | | | This is hinted-at in the introduction, which mentions creating a new variable value in the current scope, but let's make it explicit. Fixes: #22910
* | Help: Clarify behavior of if(DEFINED) for cache and non-cache variablesCraig Scott2021-12-201-1/+10
| | | | | | Fixes: #23023
* | Merge topic 'doc-if-basic-expressions'Brad King2021-12-011-4/+15
|\ \ | | | | | | | | | | | | | | | | | | | | | 294581a443 Help: Be more explicit about the behavior of if(<string>) 3a9695557d Help: Explicitly state that if(ENV{some_var}) is always false Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6768
| * | Help: Be more explicit about the behavior of if(<string>)Craig Scott2021-12-011-4/+13
| | |
| * | Help: Explicitly state that if(ENV{some_var}) is always falseCraig Scott2021-12-011-1/+3
| | |
* | | Merge topic 'doc-tests-labels-dynamic'Brad King2021-11-151-3/+12
|\ \ \ | |/ / | | | | | | | | | | | | | | | | | | 250acbb099 Help: Improve cross-referencing of test LABELS and related features a77bdefa3e Help: Add missing version details for Additional Test Measurements Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6726
| * | Help: Improve cross-referencing of test LABELS and related featuresCraig Scott2021-11-131-0/+2
| | |
| * | Help: Add missing version details for Additional Test MeasurementsCraig Scott2021-11-131-3/+10
| | |
| * | Merge topic 'doc-TARGET_RUNTIME_DLLS' into release-3.22Brad King2021-11-041-1/+4
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 001870d451 Help: Clarify TARGET_RUNTIME_DLLS behavior on imported targets Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Robert Maynard <robertjmaynard@gmail.com> Merge-request: !6700
* | | | Help: Fix target_sources FILE_SET signature summaryBrad King2021-11-051-2/+2
| | | | | | | | | | | | | | | | The `FILE_SET <set>` argument is required to activate this signature.
* | | | Help: Add versionadded markup to target_sources FILE_SET featureBrad King2021-11-052-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | This was accidentally left out of commit 4b0ee4e338 (Help: Add documentation for target_sources(FILE_SET) and associated properties, 2021-07-02).
* | | | Merge topic 'doc-SOURCES-genex'Brad King2021-11-051-18/+31
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 9fac18a4a6 Help: Clarify target_sources path conversion w.r.t generator expressions 9abd63dd3a Help: Explain how target SOURCES are interpreted Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Michael Hirsch <michael@scivision.dev> Merge-request: !6692
| * | | | Help: Clarify target_sources path conversion w.r.t generator expressionsArcturus Arcturus2021-11-041-18/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With some of the content expanded, reorder a few paragraphs and tweak some of the wording to improve the flow. Co-Authored-By: Craig Scott <craig.scott@crascit.com>
* | | | | Merge topic 'doc-TARGET_RUNTIME_DLLS'Brad King2021-11-041-1/+4
|\ \ \ \ \ | |/ / / / |/| | / / | | |/ / | |/| | | | | | | | | | | | | | 001870d451 Help: Clarify TARGET_RUNTIME_DLLS behavior on imported targets Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Robert Maynard <robertjmaynard@gmail.com> Merge-request: !6700
| * | | Help: Clarify TARGET_RUNTIME_DLLS behavior on imported targetsBrad King2021-11-031-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This generator expression does not report the locations of `.dll` files on imported targets with the `UNKNWON` type, since their `IMPORTED_LOCATION` refers to the import library and not the DLL. Fixes: #22845
* | | | Merge topic 'doc-configure_file-creates-directories'Brad King2021-10-291-0/+1
|\ \ \ \ | | |/ / | |/| | | | | | | | | | | | | | | | | | fa47e9c8f9 Help: Document that configure_file can create directories Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6675
generated by cgit v0.12 at 2026-01-16 17:42:10 (GMT)