summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
Commit message (Collapse)AuthorAgeFilesLines
* cmake: Allow arbitrary args passed to CMake scriptAlex Turbov2020-05-061-1/+5
|
* cmake -E: add cat command.Johnny Jazeix2020-04-151-0/+3
| | | | | | Concatenate files and print on the standard output. FIXES: #20557
* Merge topic 'docs-CMAKE_FIND_DEBUG_MODE'Craig Scott2020-04-061-1/+3
|\ | | | | | | | | | | | | | | 477b8b5dfe Help: Improve discoverability of CMAKE_FIND_DEBUG_MODE 218bda9671 Help: Fix CMAKE_FIND_DEBUG_MODE list formatting Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4569
| * Help: Improve discoverability of CMAKE_FIND_DEBUG_MODECraig Scott2020-04-041-1/+3
| |
* | Merge topic 'trace-format-json-doc'Brad King2020-03-191-1/+1
|\ \ | |/ | | | | | | | | | | | | 1994f950ff cmake: List valid values for --trace-format on the command line e39766d84a Help: Fix documentation of --trace-format parameter Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4500
| * Help: Fix documentation of --trace-format parameterKyle Edwards2020-03-181-1/+1
| |
* | cmake: add command line options to output script profiling dataWouter Klouwen2020-03-071-0/+14
|/ | | | | | | | | | | | | | | For users of CMake who want to optimize their scripts if they take a while to run, this commit adds the ability to output profiling data. To enable this output, it adds the two command line parameters to select the output path and format. This commit adds the first profiling format of type ``google-trace``, which is the output is a JSON file containing Duration events as per the Google Trace Format specification: https://docs.google.com/document/d/1CvAClvFfyA5R- PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview#
* trace: Add time and stack level to JSON output formatFrank Winklmeier2020-01-221-3/+11
| | | | | | | | Add the timestamp and stack depth of the function call to the JSON trace output format. This information can be useful for cmake profiling and call stack inspection (see e.g. https://github.com/volo-zyko/cmake-profile-stats). Improve unit test to allow for varying set of keys to check in trace lines.
* Merge topic 'traceJSON'Kyle Edwards2019-12-271-0/+60
|\ | | | | | | | | | | | | | | e113ab1168 trace: Add test for the JSON-v1 trace 482497e0de trace: Add JSON output format Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4102
| * trace: Add JSON output formatDaniel Mensinger2019-12-231-0/+60
| | | | | | | | | | | | | | | | Add a new `--trace-format=` flag, to enable the new JSON trace output format. This new format is easier to parse by machines than the existing format. This new format also removes the ambiguity of the whitespace in the "old" format (e.g. is that whitespace part of a file path, or does it seperate arguments)
* | find_*: Add debug logging infrastructureRobert Maynard2019-12-191-0/+6
|/ | | | | | | | | | | | Enable debug messages a new `--find-debug` command-line option or via the `CMAKE_FIND_DEBUG_MODE` variable. This work was started by Chris Wilson, continued by Ray Donnelly, and then refactored by Robert Maynard to collect information into a single message per find query. Co-Author: Ray Donnelly <mingw.android@gmail.com> Co-Author: Chris Wilson <chris+github@qwirx.com>
* cmake -E: Add rm with improved semantics over remove and remove_directoryJohnny Jazeix2019-11-131-4/+20
|
* message: Support logging a context with each messageAlex Turbov2019-10-121-0/+10
|
* message: Add new CMAKE_MESSAGE_LOG_LEVEL variableAlex Turbov2019-10-121-0/+5
|
* CLI: Rename --loglevel to --log-level for naming consistencyCraig Scott2019-10-101-1/+4
| | | | | | | Other multi-word command line options use hyphens to separate the words, so the --loglevel option introduced in CMake 3.15 was inconsistent in this regard. Rename it to --log-level but still support the original --loglevel name to preserve backward compatibility.
* Help: Fix indentation of create_symlink noteKyle Edwards2019-09-191-2/+2
|
* Help: Fix ordering of cmake -E commandsKyle Edwards2019-09-181-9/+9
| | | | | Several of the commands were not in alphabetical order. Fix the ordering.
* cmake: Document -E remove_directory symlink behaviorBrad King2019-09-051-1/+2
| | | | | | | | Update documentation for the change made by commit e6c9a8bac3 (cmake: Teach -E remove_directory to remove directory symlinks, 2019-08-26). Also add a release note. Issue: #19533
* Help: Fix copy_directory descriptionLeonid Pospelov2019-09-021-1/+1
|
* Add --trace-redirect parameter to redirect trace output to a fileIgor Ivanov2019-08-101-0/+3
|
* cmake -E: Add true and false commandsKyle Edwards2019-07-111-0/+6
|
* Merge topic 'loglevel-option-case-consistency'Craig Scott2019-07-091-2/+2
|\ | | | | | | | | | | | | 14ed40d670 Help: Use consistent levels for cmake --loglevel and message() Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3521
| * Help: Use consistent levels for cmake --loglevel and message()Craig Scott2019-07-081-2/+2
| | | | | | | | | | | | | | | | | | | | The message() command requires uppercase log levels. Even though the cmake --loglevel option is not case sensitive, show the supported values as uppercase to match the message() docs as closely as possible, since they are related to the same feature. Also fixes the wrong string being shown for the warning level by cmake --help.
* | Help: Remove mention of CMAKE_INSTALL_DO_STRIPCraig Scott2019-07-031-1/+1
| | | | | | | | | | | | | | It isn't yet clear whether we want to make this part of the documented API for the install script. Remove it from the docs before it appears in an official release for now. Relates: #18997
* | Help: Clarify how to provide multiple targets with cmake --targetCraig Scott2019-07-031-1/+2
| |
* | Help: Clean up trivial typos and grammarCraig Scott2019-07-031-2/+2
|/
* cmake: Teach -E capabilities to report supported fileapi requestsBrad King2019-06-071-0/+16
| | | | Fixes: #19339
* cmake: Teach -E remove_directory to remove multiple directoriesJohn Freeman2019-06-031-2/+2
| | | | | The `make_directory` command can make multiple directories in a single invocation. Make `remove_directory` mirror that behavior.
* Merge topic 'tar-zstd-compression'Brad King2019-05-301-5/+8
|\ | | | | | | | | | | | | 53cb1f2d04 cmake: Teach cmake -E tar command, Zstandard compression Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3357
| * cmake: Teach cmake -E tar command, Zstandard compressionBartosz Kosiorek2019-05-221-5/+8
| | | | | | | | Fixes #18657
* | cmake: tar: Allow selective extracting and listing of archivesBartosz Kosiorek2019-05-231-3/+9
|/
* Merge topic 'jobs-positive-value'Brad King2019-05-031-0/+3
|\ | | | | | | | | | | | | 6ad699358b cmake: --build -j <jobs> should not accept 0. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3255
| * cmake: --build -j <jobs> should not accept 0.Fred Baksik2019-05-011-0/+3
| | | | | | | | Fixes #19059
* | message(): Add support for log levelsAlex Turbov2019-04-281-0/+6
|/ | | | | Relates: #18943 Co-Authored-By: Craig Scott <craig.scott@crascit.com>
* Help: Improve formatting of Help documentationBartosz Kosiorek2019-04-081-16/+17
|
* Merge topic 'cmake--install'Kyle Edwards2019-03-191-2/+40
|\ | | | | | | | | | | | | | | | | | | | | 73f23d1e00 cmake: add '--install <dir>' option Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Alex Turbov <i.zaufi@gmail.com> Acked-by: Bartosz <gang65@poczta.onet.pl> Acked-by: Cristian Adam <cristian.adam@gmail.com> Rejected-by: Alex Turbov <i.zaufi@gmail.com> Merge-request: !3069
| * cmake: add '--install <dir>' optionJiang Yi2019-03-161-2/+40
| | | | | | | | Fixes: #19023
* | Help: Update 'tar' documentation with supported argumentsBartosz Kosiorek2019-03-181-0/+15
| |
* | Merge topic 'short-commands'Brad King2019-03-141-3/+3
|\ \ | | | | | | | | | | | | | | | | | | | | | 077ab5774c cmake: add short version of '--target <tgt>...' option 071f5e1544 cmake: Reformat '--parallel' and '--verbose' options in help Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3078
| * | cmake: add short version of '--target <tgt>...' optionBartosz Kosiorek2019-03-121-1/+1
| | |
| * | cmake: Reformat '--parallel' and '--verbose' options in helpBartosz Kosiorek2019-03-121-2/+2
| |/
* | cmake: Upgrade 'cmake -E' commands descriptionBartosz Kosiorek2019-03-121-4/+12
|/ | | | Fixes: #13204
* cmake: Teach --build mode to support multiple targetsBartosz Kosiorek2019-03-051-2/+2
| | | | Fixes: #16136
* Merge topic 'add_consistent_verbose_build_flag'Brad King2019-01-291-0/+8
|\ | | | | | | | | | | | | | | | | | | | | | | 66801f4d40 cmake: Add tests for verbose output to --build mode 439fe2e253 cmake: Add options for verbose output to --build mode 638667efa2 cmake: cmcmd.cxx fix "The arguments are" comments 3ca4402966 ctest: Fix --build-and-test without --build-target on Xcode cb6c233ecc cmake: Add -hideShellScriptEnvironment xcodebuild option 1a45266cb5 cmGlobalGenerator: Add a class that represent the build command Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2708
| * cmake: Add options for verbose output to --build modeFlorian Maushart2019-01-281-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | While we already support `VERBOSE` environment variable and `CMAKE_VERBOSE_MAKEFILE` cached variable, add `-v` and `--verbose` command line options to be able to activate verbose output directly from CMake's build tool mode command line. Also make `msbuild` honor the verbosity setting. `xcodebuild` still doesn't honor the verbosity setting as it will need a policy added and reworking of cmGlobalGenerator and cmsys to support multiple command invocation.
* | cmake: Add --ignore-eol option to `-E compare_files` commandTaylor Braun-Jones2019-01-281-2/+3
|/ | | | Fixes: #13007
* Help: Extend the cmake(1) manualBrad King2018-11-271-21/+116
| | | | | | | | Extend the description section to cover all capabilities that the "cmake" tool has. Extend the buildsystem generation section to introduce important concepts and describe the basic workflow. Inspired-by: Joachim Wuttke (l) <j.wuttke@fz-juelich.de>
* Help: Improve cmake(1) manual organizationJoachim Wuttke (l)2018-11-271-48/+107
| | | | | | | | | | | Extend the Synposis, and provide links to manual sections. Add sections for `cmake --open` and `cmake --help-*`. Introduce a new section for buildsystem generation to distinguish it from the other functionality. Populate it with minimal placeholder text for now. It will be extended later. Co-Author: Brad King <brad.king@kitware.com>
* Help: Emphasize tool names in their manualsJoachim Wuttke (l)2018-11-261-1/+1
| | | | | | Print the name of the **cmake** executable in boldface, so that it does not appear less prominent than other shell commands (which are underlaid with links). Similarly the other tool manuals.
* Merge topic 'symlink'Brad King2018-09-191-5/+0
|\ | | | | | | | | | | | | afb7f6e4ff cmake: Add '-E create_symlink' support on Windows Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2144