summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* cmake_file_api: New project commandCraig Scott2023-06-051-0/+78
| | | | | | | | Projects can use the new command to request file API replies for the current run. No query files are generated, the query is tracked internally. Replies are created in the file system at generation time in the usual way. Fixes: #24951
* cxxmodules: remove support for `CXX_MODULE_HEADER_UNITS` filesetsBen Boeckel2023-05-311-26/+6
| | | | | There's no backing implementation for header units anyways, so just remove it for now.
* Merge topic 'help_configure_file'Brad King2023-05-231-4/+4
|\ | | | | | | | | | | | | b2b97d015e Help: configure_file: add $CACHE{VAR} and $ENV{VAR} to description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8500
| * Help: configure_file: add $CACHE{VAR} and $ENV{VAR} to descriptionTorsten Rasmussen2023-05-221-4/+4
| | | | | | | | | | | | | | | | The configure_file(...) and string(CONFIGURE ...) functions also substitutes variables of the form: $CACHE{VAR} and $ENV{VAR}. Therefore add this information to the help documentation so that this behavior is described to users
* | codespell: Fix typosBrad King2023-05-221-1/+1
|/
* Help: Clarify PRE_BUILD option for add_custom_command()Craig Scott2023-05-191-3/+6
| | | | Fixes: #24889
* Help: Document append functionality of string(JSON)Leonid Pospelov2023-05-031-0/+3
|
* Help: change links to point to the env.vars, not to the cmake varsAlex Neundorf2023-05-016-5/+32
| | | | | | | The documentation of the find-commands was pointing to the cmake variables CMAKE_PREFIX_PATH, CMAKE_INCLUDE_PATH etc. also in the section for environment variables. Now they point to the documentation for the respective environment variables.
* GenEx LIST: list operationsMarc Chevrier2023-04-161-15/+15
| | | | Fixes: #24550, #24547
* Help: Clarify that {add,target}_compile_options are not used for linkingBrad King2023-03-314-0/+28
| | | | | | Link to alternatives that can be used for adding link options. Issue: #24662
* Help: Link to COMPILE_LANGUAGE genex from add_compile_optionsBrad King2023-03-311-0/+4
| | | | | | | Follow-up commit e2830cf16b (Help: Link to COMPILE_LANGUAGE genex from target_compile_options, 2023-03-28). Issue: #24639
* Help: Link to COMPILE_LANGUAGE genex from target_compile_optionsBrad King2023-03-281-0/+4
| | | | Issue: #24639
* Merge topic 'file-GET_RUNTIME_DEPENDENCIES-windows-casing'Brad King2023-03-281-9/+16
|\ | | | | | | | | | | | | | | | | 5922c86ed6 file(GET_RUNTIME_DEPENDENCIES): Document case-preserving change on Windows 7dffe99ad8 Tests: Restore CudaOnly.RuntimeControls cudart verification on Windows Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Kyle Edwards <kyle.edwards@kitware.com> Merge-request: !8367
| * file(GET_RUNTIME_DEPENDENCIES): Document case-preserving change on WindowsBrad King2023-03-271-9/+16
| | | | | | | | | | | | In commit fa45594407 (file(GET_RUNTIME_DEPENDENCIES): Preserve casing for Windows PE binaries, 2023-03-06) we neglected to update associated documentation.
* | Help: Clarify that set(VAR) unsets VARBrad King2023-03-243-12/+21
|/ | | | | | | | Also call out possible exposure of an existing cache entry of the same name, as we have for the `unset` command since commit 1a0f1a25a4 (Help: Clarify the unset command, 2018-08-17, v3.13.0-rc1~199^2). Issue: #24633
* Help: Improve file command signaturesMatthew Woehlke2023-03-151-5/+5
| | | | | Fix a couple of file command signatures that were not using angle brackets to mark arguments.
* Help: Convert signatures of file commandMatthew Woehlke2023-03-153-931/+899
| | | | | | | | | | | | Convert `file` command to use new `signature` directive. Use '<HASH>' rather than 'HASH' for relevant signature targets, as this is arguably more correct, results in less need to specify explicit targets, but still produces '#hash' as the HTML anchor. Although actual textual changes to `file` are fairly minimal, large portions of the content have been re-indented and in many cases, re-flowed. Some tabular content in literal text blocks has also been converted to actual tables.
* Help: Convert signatures of list and set commandsMatthew Woehlke2023-03-152-277/+248
| | | | | | | | Convert documentation of the `list` and `set` commands to use new `signature` directive. Use new `cref` role in the `list` introduction so that the subcommands there are links rather than just text. Turn references into `string` subcommands into actual links. Reformat some prose as definition lists.
* Help: Use signature directive for 'if' commandBrad King2023-03-071-70/+90
|
* Help: Improve sentence structure around "if so"Brad King2023-03-071-6/+6
|
* Help: Add internal cross-references to 'if' command docsBrad King2023-03-071-12/+14
|
* Help: Indent 'if' command docs more consistentlyBrad King2023-03-071-102/+102
|
* Merge topic 'improve-doc-signatures'Brad King2023-03-072-496/+409
|\ | | | | | | | | | | | | | | | | | | | | 533ebb072b Help: Use signature directive for string command cd33f461a6 Help: Use signature directive for cmake_language command 74e3c1d313 Utilities/Sphinx: Add a directive to document command signatures c09b760484 Utilities/Sphinx: Drop commented-out code from cmake domain impl 6e85ad7f8b Help/dev: Add per-directive sections in CMake Documentation Guide Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8243
| * Help: Use signature directive for string commandMatthew Woehlke2023-03-061-330/+256
| |
| * Help: Use signature directive for cmake_language commandMatthew Woehlke2023-03-061-166/+153
| |
* | Merge topic 'Apple-handle-Text-Stubs'Brad King2023-03-021-0/+18
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | ede33f30cf Apple: Handle generation and comsuption of text-based stubs (.tbd files) fcbd723a50 Enhance support functions Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Brad King <brad.king@kitware.com> Merge-request: !8204
| * | Apple: Handle generation and comsuption of text-based stubs (.tbd files)Marc Chevrier2023-03-011-0/+18
| | | | | | | | | | | | Fixes: #24123
* | | Merge topic 'try-doc'Brad King2023-03-012-39/+37
|\ \ \ | |/ / |/| | | | | | | | | | | | | | b6cfbe7b17 Help:try_{compile,run}: clarify, encourage new syntax Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8262
| * | Help:try_{compile,run}: clarify, encourage new syntaxscivision2023-02-282-39/+37
| | |
* | | Help:file: document HTTPHEADER morescivision2023-02-241-1/+8
| | | | | | | | | | | | | | | | | | Some servers have allow-lists for HTTP UserAgent for example. CMake project devs would benefit from this hint about setting authorization tokens and HTTP User Agent.
* | | find_package: Use <PACKAGENAME>_ROOT variables as search prefixesBrad King2023-02-232-2/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | Extend commit eb35d8884b (find_package: Use PackageName_ROOT variables as search prefixes, 2018-03-15, v3.12.0-rc1~349^2) to also check upper-case `<PACKAGENAME>_ROOT` variables. Add policy `CMP0144` to enable the behavior in a compatible way. Fixes: #24403
* | | Help: Document <PackageName>_ROOT variable ordering using an ordered listBrad King2023-02-232-26/+41
| |/ |/| | | | | Make room to add more steps in a documented order.
* | Merge topic 'ninja-custom-command-depends'Brad King2023-02-201-0/+3
|\ \ | | | | | | | | | | | | | | | | | | | | | ea2a05f402 Add variable CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8220
| * | Add variable CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLYAbdelmaged Khalifa2023-02-171-0/+3
| | | | | | | | | | | | | | | | | | | | | Add CMake variable `CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` to enable option `DEPENDS_EXPLICIT_ONLY` on all uses of `add_custom_command`. Fixes: #17097
* | | Merge topic 'ci-linkcheck'Brad King2023-02-171-1/+1
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | | | | 0787148785 gitlab-ci: Report sphinx logs as artifacts of its lint job 14506f49a2 Utilities/Sphinx: Configure linkcheck allowed permanent redirects 3c5b34af9d Help: Replace links with their permanent redirects 1004be159f FindCUDAToolkit: Replace broken links to NVIDIA documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8210
| * | Help: Replace links with their permanent redirectsBrad King2023-02-171-1/+1
| | |
* | | Help:add_test: emphasize important pointsscivision2023-02-152-37/+32
|/ / | | | | | | | | | | | | * enable_testing must be called to enable testing * can only set properties on tests created in same directory * WILL_FAIL still fails on segfault and similar * compact wording
* | Merge topic 'ninja-custom-command-depends'Brad King2023-02-151-1/+17
|\ \ | | | | | | | | | | | | | | | | | | 082ccd7530 add_custom_command: Add DEPENDS_EXPLICIT_ONLY option for Ninja Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8198
| * | add_custom_command: Add DEPENDS_EXPLICIT_ONLY option for NinjaAbdelmaged Khalifa2023-02-141-1/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | Add option `DEPENDS_EXPLICIT_ONLY` to `add_custom_command` to indicate that implicit dependencies coming from users of the output are not needed, and only consider dependencies explicitly specified in the custom command. Fixes: #17097
* | | Help: math: note that floating point inputs are invalidscivision2023-02-141-1/+2
|/ /
* | Merge topic 'doc-find_package-root-case'Brad King2023-02-091-1/+2
|\ \ | |/ | | | | | | | | | | 20e727a408 Help: Clarify that <PackageName>_ROOT variable names are case-preserved Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8182
| * Help: Clarify that <PackageName>_ROOT variable names are case-preservedBrad King2023-02-081-1/+2
| | | | | | | | | | The name comes from the case-preserved first argument to `find_package`.
* | Merge topic 'KateImprovements'Brad King2023-02-071-1/+1
|\ \ | |/ |/| | | | | | | | | | | | | | | | | | | e7f7bff4f5 Kate: improve the way the VCS-specific files are searched 96389b4cd3 Kate: add support for hg and fossil 4c32623f5f Help: fix typo in docs for set_property() 9a7612d2d0 Kate: make it possible to force a mode for the "files" entry 8a7aa2642b Help: add documentation for Kate-related variable Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8154
| * Help: fix typo in docs for set_property()Alexander Neundorf2023-02-061-1/+1
| |
* | Help: Clarify interaction of execute_process *_FILE and *_VARIABLE optionsscivision2023-02-061-34/+40
|/ | | | | | | These parameters are so important that it's worthwhile to be more explicit about their interaction. Fixes: #24392
* Help: Clarify add_custom_command OUTPUT relative path behaviorBrad King2023-01-301-3/+12
| | | | Issue: #24372
* Help: configure_file doc example use `target_include_directories`Robert Maynard2023-01-251-2/+2
| | | | Fixes #24351
* Merge topic 'isdir_empty'Brad King2023-01-251-2/+6
|\ | | | | | | | | | | | | a1dc38a567 Help: Document behavior of if(EXISTS,IS_DIRECTORY) for empty paths Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8109
| * Help: Document behavior of if(EXISTS,IS_DIRECTORY) for empty pathsscivision2023-01-241-2/+6
| | | | | | | | | | | | | | | | | | | | Document and add explicit tests for empty string input: `if(EXISTS "")` and `if(IS_DIRECTORY "")` are always false. This avoids need for users to do extra checks due to CMake non-short-circuit logic as below: if("${p}") if(EXISTS "${p}")
* | Help: Update supported languages in project and enable_languageRobert Maynard2023-01-203-31/+31
|/
generated by cgit v0.12 at 2025-02-10 11:58:23 (GMT)