summaryrefslogtreecommitdiffstats
path: root/Help/command/configure_file.rst
Commit message (Collapse)AuthorAgeFilesLines
* 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
* Help: configure_file doc example use `target_include_directories`Robert Maynard2023-01-251-2/+2
| | | | Fixes #24351
* Help: Fix typo in configure_file docsGustaf Borgström2023-01-111-1/+1
|
* Help: Add _See Also_ sections to related CMake commandsAlex Turbov2022-11-091-0/+5
|
* Help: Document that configure_file can create directoriesMarc Aldorasi2021-10-281-0/+1
|
* Merge topic 'commands-file-permissions'Brad King2021-03-291-15/+22
|\ | | | | | | | | | | | | | | | | | | 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-261-15/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Clarify configure_file #cmakedefine01 syntax and behaviorElsie Hupp2021-03-151-2/+24
|/ | | | Fixes: #21935
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-11/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 '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
* | Help: Cleanup typos and grammar for the 3.19 releaseCraig Scott2020-10-241-1/+1
|/
* configure_file: Add option to control file permissions transfer to copyRahul Gottipati2020-06-301-0/+6
| | | | Issue: #20866
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-6/+16
| | | | | | | | | | | | | | | | | | | 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
* Merge topic 'doc_configure_file'Brad King2017-07-111-0/+2
|\ | | | | | | | | | | | | c7d81e16 Help: Explicitly state that some file generations are lazy Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1025
| * Help: Explicitly state that some file generations are lazySylvain Joubert2017-07-071-0/+2
| | | | | | | | Fixes: #16856
* | configure_file: Add support for indented cmakedefineSylvain Joubert2017-07-041-0/+12
|/ | | | | | | | Optional spaces and/or tabs are now understood between the '#' character and the 'cmakedefine'/'cmakedefine01' words. This indentation is preserved in the output lines. Fixes: #13037
* Help: Revise configure_file documentation (#15403)Brad King2015-02-121-30/+95
| | | | | | Format the documentation with better reST markup. Revise the wording to clarify how relative paths are handled. Also add an example section.
* Help: Fix reStructuredText syntax in auto-generated documentsBrad King2013-10-151-1/+1
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+46
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-01-22 09:48:59 (GMT)