summaryrefslogtreecommitdiffstats
path: root/Help/command/get_filename_component.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Convert signatures of file commandMatthew Woehlke2023-03-151-3/+3
| | | | | | | | | | | | 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: Add _See Also_ sections to related CMake commandsAlex Turbov2022-11-091-0/+5
|
* cmake_host_system_information(WINDOWS_REGISTRY) updatesMarc Chevrier2022-05-011-2/+8
| | | | | * add a cross-reference in 'get_filename_component()' documentation * rework tests for better 32bit systems support
* Help: get_filename_component: fix version info for cmake_pathMarc Chevrier2021-08-021-1/+1
| | | | Fixes: #22505
* Help: Fix grammar in `.. versionadded` directivesNikita Nemkin2020-12-021-1/+1
| | | | Issue: #19715
* Help: Replace some `versionadded` directives with `versionchanged`Nikita Nemkin2020-11-121-1/+1
| | | | | | | | `.. 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/get_filename_component: clarify NAME_W[L]E summariesBen Boeckel2020-11-101-2/+2
| | | | | | | | | | | | There was an ambiguity in the wording with the meaning of "or" typically meaning exclusive-or in prose. Instead, ensure that the easiest parsing is clear that the directory part is always removed.
| * cmake_path: remove new command from 3.19Marc Chevrier2020-11-031-3/+3
| | | | | | | | | | | | | | Defer adding this command until post-3.19 development so that it has more time to mature before being included in a release. Issue: #21385
* | Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-6/+10
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* separate_arguments: add option PROGRAMMarc Chevrier2020-09-221-6/+6
| | | | Fixes: #21217
* file(): Add REAL_PATH sub-commandMarc Chevrier2020-09-081-2/+3
|
* cmake_path command: path managementMarc Chevrier2020-09-061-0/+5
| | | | Fixes: #19568, #20922
* Help: Remove outdated statement about get_filename_component()Craig Scott2019-02-161-4/+3
| | | | | | | | After !2853, the statement that the "longest file extension is always considered" is no longer true. Both NAME_WLE and LAST_EXT now return details based on the shortest file extension. Fixes: 7a25ef326b (Help: Add documentation for new get_filename_component components, 2019-01-24, 3.14.0-rc1)
* Help: Add documentation for new get_filename_component componentsTushar Maheshwari2019-01-241-0/+2
|
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-20/+10
| | | | | | | | | | | | | | | | | | | Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
* Help: Some spelling corrections for commands.Yee Fan2018-04-201-1/+1
|
* Help: Fix typo in get_filename_component docsChristopher Meng2015-09-081-1/+1
| | | | trailing slahes -> trailing slashes
* get_filename_component: Teach new BASE_DIR parameter.James Johnston2015-08-181-5/+32
| | | | | | In the get_filename_component command, add a new BASE_DIR parameter to use with the ABSOLUTE and REALPATH options. This will be used when finding an absolute path from a relative path.
* Help: Improve formatting of command documentationMichael Scott2015-06-081-6/+6
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+37
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
generated by cgit v0.12 at 2025-09-11 15:36:12 (GMT)