summaryrefslogtreecommitdiffstats
path: root/Help/command/file.rst
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'file-ARCHIVE-files-dirs' into release-3.18Brad King2020-07-011-14/+16
|\ | | | | | | | | | | | | bbcff21f71 file(ARCHIVE*): Collapse FILES and DIRECTORY options Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4955
| * file(ARCHIVE*): Collapse FILES and DIRECTORY optionsCraig Scott2020-06-301-14/+16
| | | | | | | | | | | | | | | | The two options were concatenated internally for both ARCHIVE_CREATE and ARCHIVE_EXTRACT. The distinction between files and dirs was not meaningful. Therefore, replace them with PATHS or PATTERNS to more accurately describe the way the options are used. Fixes: #20884
* | Merge topic 'file-CONFIGURE-subdir' into release-3.18Brad King2020-06-301-2/+1
|\ \ | |/ |/| | | | | | | | | e5f5eeca2f file: Fix CONFIGURE output relative path Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4951
| * file: Fix CONFIGURE output relative pathBrad King2020-06-291-2/+1
| | | | | | | | | | | | | | | | | | In commit a6fee09484 (file: Add CONFIGURE subcommand, 2020-03-06, v3.18.0-rc1~584^2) we accidentally treated relative path outputs with respect to the current working directory. Treat them with respect to the current binary directory instead. Fixes: #20885
* | file(ARCHIVE_CREATE): Rename TYPE option to COMPRESSIONCraig Scott2020-06-271-12/+14
| | | | | | Fixes: #20883
* | Help: Fix contents indenting for file(ARCHIVE_...) subcommandsCraig Scott2020-06-271-3/+3
|/
* file(UPLOAD): Add support for TLS_VERIFY and TLS_CAINFOHarry Mallon2020-04-081-13/+12
| | | | | * Improve and test err messages when TLS_VERIFY and TLS_CAINFO are not set in file(DOWNLOAD) and file(UPLOAD).
* file: GetRuntimeDependencies use CMAKE_OBJDUMP when applicableRobert Maynard2020-04-061-2/+2
| | | | | | | | | On machines where the gnu bin utils are prefixed, or suffixed the file(GET_RUNTIME_DEPENDENCIES ) command would fail without explicitly setting the location of objdump. Now we pre-populate the variables used to find objdump based on the gnu bin utils, so that these use cases are better supported
* file: Add ARCHIVE_{CREATE|EXTRACT} subcommandsCristian Adam2020-03-161-0/+63
| | | | Fixes: #20443
* file: Add CONFIGURE subcommandLeander Beernaert2020-03-091-0/+40
| | | | | | | | Extend the `file()` command with a new `CONFIGURE` subcommand that behaves the same as `string(CONFIGURE)` except that it writes the resulting output immediately to a file. Fixes: #20388
* Help: Make note that file(READ ... HEX) produces lowercase lettersKyle Edwards2020-02-191-1/+3
|
* file: Fix GLOB_RECURSE LIST_DIRECTORIES documentation regarding CMP0009Shane Parris2020-02-111-1/+1
|
* Help: Typo and grammar fixes for file(GET_RUNTIME_DEPENDENCIES)Craig Scott2019-11-031-10/+10
| | | | | | Note that ``MODULE`` s was rendering strangely, so the wording has been tweaked to avoid needing to specify ``MODULE`` as a plural word. Modules are still libraries, so it is okay to call them as such where it doesn't cause any ambiguity.
* Help: Fix spelling error in file(GET_RUNTIME_DEPENDENCIES) docsMarc Chevrier2019-10-301-1/+1
|
* Help: Mention file(GLOB)'s case-sensitivitySteve Mokris2019-07-101-0/+5
| | | | Based on the KWSYS_GLOB_CASE_INDEPENDENT flag in `Source/kwsys/Glob.cxx`.
* file: Add GET_RUNTIME_DEPENDENCIES modeKyle Edwards2019-06-101-0/+268
| | | | Co-Authored-by: Bryon Bean <bryon.bean@kitware.com>
* file: Change REMOVE to ignore empty namesBrad King2019-05-211-1/+2
| | | | | | | | | | | | | | | Previously code like file(REMOVE_RECURSE "${accidentally_missing_variable}") treated the empty string as a relative path with respect to the current directory and removed its contents. Change this behavior to ignore the empty string with a warning instead. Normally such behavior changes are done with a policy, but in this case such code is likely a real bug in project code that can delete data. Fixes: #19274
* file(INSTALL): Add FOLLOW_SYMLINK_CHAIN argumentKyle Edwards2019-05-161-0/+27
|
* Help: Clarify and improve readability of link-related file subcommandsCraig Scott2019-02-161-23/+23
|
* Help: Add documentation for file(CREATE_LINK) subcommandTushar Maheshwari2019-01-161-0/+23
|
* file: Add READ_SYMLINK sub-commandKyle Edwards2018-12-061-0/+24
|
* file: add SIZE optionWouter Klouwen2018-11-271-0/+11
| | | | | This commit adds the SIZE option to file(). It returns the file size of the given path if it exists and produces an error if not.
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-16/+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
* Help: Organize file command docs into sectionsBrad King2018-05-071-16/+75
| | | | | | Add a synopsis section at the top summarizing all signatures. Issue: #17948
* Help: Re-order file command docsBrad King2018-05-071-125/+125
| | | | Prepare for the addition of section headers for grouping commands.
* Adjust help documentation for file(GLOB), add topic notesShane Parris2018-04-021-2/+11
|
* Adds file(TOUCH) and file(TOUCH_NOCREATE) sub-commandsShane Parris2018-02-151-0/+17
|
* Fix trivial typos in textluzpaz2017-11-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Some are user facing. Found using codespell -q 3 --skip="./Utilities" -I .cmake-whitelist.txt` whereby the whitelist contained: ans dum helpfull emmited emmitted buil iff isnt nto ot pathes substract te todays upto whitespaces
* file(DOWNLOAD|UPLOAD): Add 'NETRC' and 'NETRC_FILE' suboptionShane Parris2017-10-181-0/+25
|
* Merge topic 'file_WRITE_docs'Brad King2017-08-041-2/+5
|\ | | | | | | | | | | | | d7472bbf file: Clarify directory creation behavior when using WRITE Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1088
| * file: Clarify directory creation behavior when using WRITERobert Dailey2017-08-031-2/+5
| | | | | | | | | | | | | | When using `file(WRITE)`, parent directories are also created. Documentation has been updated to explain this behavior. Co-Author: Craig Scott <craig.scott@crascit.com>
* | Help: Document that file(GLOB) result is sortedRuslan Baratov2017-08-031-3/+1
| | | | | | | | | | | | | | It has been sorted since commit v3.6.0-rc1~54^2 (file: Sort GLOB results to make it deterministic, 2016-05-14). That commit left the order unspecified in the documentation, but has been stable long enough to document now.
* | Help: Explicitly state that some file generations are lazySylvain Joubert2017-07-071-2/+2
| | | | | | | | Fixes: #16856
* | file(GENERATE): Add policy CMP0070 to define relative path behaviorBrad King2017-06-091-0/+5
|/ | | | | | | | | Previously `file(GENERATE)` did not define any behavior for relative paths given to the `OUTPUT` or `INPUT` arguments. Define behavior consistent with CMake conventions and add a policy to provide compatibility for projects that relied on the old accidental behavior. Fixes: #16786
* Help: Clarify file(GENERATE) only writes output file at generation phaseCraig Scott2017-04-101-0/+5
| | | | Closes: #16556
* Help: De-duplicate and spell out supported hash algorithmsBrad King2016-11-101-4/+6
| | | | | | | Spell out the supported algorithms in a definition list in the `string(<HASH>)` command documentation. Revise the `file(<HASH>)` command and CPack module documentation to reference it instead of duplicating the list.
* Help: Document error behavior of file(REMOVE/REMOVE_RECURSE)Christian Fetzer2016-11-011-1/+2
| | | | | Clarifies that there is no need to surround file(REMOVE/REMOVE_RECURSE) calls by `if(EXISTS)` as non existent files are silently ignored.
* file(DOWNLOAD|UPLOAD): Add HTTPHEADER suboptionRuslan Baratov2016-09-151-0/+3
|
* file(DOWNLOAD|UPLOAD): Add 'USERPWD' suboptionRuslan Baratov2016-09-131-0/+3
|
* file: Sort GLOB results to make it deterministic (#14491)Reiner Herrmann2016-05-171-2/+3
| | | | | | | | | | | | | | | | | Even though the `file(GLOB)` documentation specifically warns against using it to collect a list of source files, projects often do it anyway. Since it uses `readdir()`, the list of files will be unsorted. This list is often passed directly to add_executable / add_library. Linking binaries with an unsorted list will make it unreproducible, which means that the produced binary will differ depending on the unpredictable `readdir()` order. To solve those reproducibility issues in a lot of programs (which don't explicitly `list(SORT)` the list manually), sort the resulting list of the `file(GLOB)` command. A more detailed rationale about reproducible builds is available [here](https://reproducible-builds.org/).
* Help: Document that file(GLOB*) order is undefinedRuslan Baratov2015-10-211-1/+2
| | | | | | Since this command use 'readdir' under the hood the order of list is undefined: * http://stackoverflow.com/questions/8977441/does-readdir-guarantee-an-order
* Help: Clarify file(COPY) directory semantics (#15561)Brad King2015-05-081-1/+5
| | | | State explicitly that directory structure is preserved.
* file: Teach GLOB to list directories optionallyDomen Vrankar2015-03-201-3/+14
| | | | | | GLOB lists directories by default and GLOB_RECURSE does not. LIST_DIRECTORIES enables user to control the behavior explicitly for consistently for both GLOB and GLOB_RECURSE.
* file: Teach STRINGS to support UTF-16 and UTF-32 encodingsJustin Borodinsky2015-01-271-1/+4
|
* Merge topic 'doc-file-GENERATE-order'Brad King2014-12-051-1/+3
|\ | | | | | | | | fe21580b Help: Document file(GENERATE) signature option order
| * Help: Document file(GENERATE) signature option orderBrad King2014-12-051-1/+3
| | | | | | | | | | | | | | | | In commit v3.1.0-rc1~484^2 (Help: Format and revise file() command documentation, 2014-05-23) the signature of file(GENERATE) was accidentally simplified too much and dropped specification of the required argument ordering. Restore the signature to make the order clear.
* | file: Add LOCK subcommand to do file and directory lockingRuslan Baratov2014-12-031-0/+30
|/ | | | | | | | | Provide options to fail without blocking or to block up to a timeout. Provide options to specify the scope containing the lock so it can be released automatically at the end of a function, file, or process. Extend the RunCMake.file test with cases covering the file(LOCK) command usage and error cases.
* file: Add ENCODING option to file(STRINGS) command (#10519)Clinton Stimpson2014-08-061-0/+3
| | | | Support extraction of UTF-8 strings.
* install: Add CMAKE_INSTALL_MESSAGE variable (#13761)Brad King2014-06-241-1/+2
| | | | | | | | | Create a variable to allow users to control which installation messages are printed. In particular, provide a "LAZY" setting that prints "Installing" messages but not "Up-to-date" messages. This is desirable for incremental re-installations. Suggested-by: J Decker <d3ck0r@gmail.com>
* Help: Document that file(GENERATE) re-writes only when needed.Stephen Kelly2014-06-051-0/+2
|
generated by cgit v0.12 at 2025-09-04 06:17:25 (GMT)