summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'cmake-E-cat-stdin'Brad King2023-11-061-0/+4
|\ | | | | | | | | | | | | | | ab72846794 cmake -E cat: Add ability to print standard input Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8942
| * cmake -E cat: Add ability to print standard inputKyle Edwards2023-11-031-0/+4
| |
* | CMakeFindPackageMode: Link to cmake --find-package documentation權少2023-11-031-0/+1
|/
* Help:cmake(1): add versionadded back to 3.17scivision2023-09-241-0/+14
|
* cmake: Add debuggerGlen Chung2023-05-301-0/+53
| | | | | | | | | | | | | | | | - Depends on cppdap and jsoncpp. - Add --debugger argument to enable the Debugger. - Add --debugger-pipe argument for DAP traffics over named pipes. - Support breakpoints by filenames and line numbers. - Support exception breakpoints. - Call stack shows filenames and line numbers. - Show Cache Variables. - Show the state of currently defined targets, tests and directories with their properties. - Add cmakeVersion to DAP initialize response. - Include unit tests. Co-authored-by: Ben McMorran <bemcmorr@microsoft.com>
* Help: cmake (1): put modern configure signature firstscivision2023-02-191-18/+18
| | | | | | | | | | recommend compact, most robust signature first. So many people are still using the multi-step pre-3.13 way of initializing a build. Rather than simply cmake -Bbuild which is one step instead of 3 just to configure a new project.
* Merge topic 'deprecate-extra-generators'Brad King2023-02-161-1/+1
|\ | | | | | | | | | | | | | | ef5a4d964b Deprecate "extra" generators in favor of cmake-file-api(7) Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8211
| * Deprecate "extra" generators in favor of cmake-file-api(7)Brad King2023-02-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | The "extra" generators were created in CMake's early years to provide support for users of specific IDEs by directly generating their project files alongside make or ninja files. Nowadays the file-api provides a more generic, maintainable, well-tested, and robust way for IDEs to view CMake project build trees. Deprecate the legacy "extra" generators to encourage the corresponding IDEs to use the file-api. Fixes: #19090
* | Help:cmake -E time: note overhead includedscivision2023-02-151-1/+1
|/
* Help: cmake(1): sleep can have floating point valuescivision2023-02-141-2/+9
|
* Help: cmake (1): remove -E server as not availablescivision2023-02-061-4/+0
| | | | ... since CMake 3.20
* cmake: Add -E copy_directory_if_differentRobert Maynard2023-01-121-0/+10
| | | | Fixes #21584
* cmake -E copy: Add support for -t argumentKyle Edwards2022-11-151-5/+9
| | | | Fixes: #23543
* Help: Use `caption` option of `code-block` for JSON trace format snippetsAlex Turbov2022-11-071-4/+2
|
* Help: Use role `:program:`Alex Turbov2022-11-061-7/+7
| | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* cmake --workflow: add --fresh optionKyle Edwards2022-10-261-0/+6
| | | | Fixes: #24073
* Help: cmake(1), ctest(1), versionadded for key flagsMichael Hirsch2022-10-211-0/+5
|
* Help: Make cmake(1) sub-command options look like other optionsAlex Turbov2022-10-121-21/+61
| | | | | | | Particularly, - options for `cmake -E env` - options for `cmake -E tar`
* Help: Minor grammar, typo and formatting cleanupsCraig Scott2022-10-091-1/+1
|
* Merge topic 'try_compile-more-debug-logging'Brad King2022-10-061-0/+5
|\ | | | | | | | | | | | | | | 7e6b2a92a0 try_compile: Report build dir with --debug-trycompile cbf3252975 Tests: Remove stray debugging flag from RunCMake.CheckCompilerFlag case Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7746
| * try_compile: Report build dir with --debug-trycompileMatthew Woehlke2022-10-061-0/+5
| | | | | | | | | | | | | | | | When `--debug-trycompile` is enabled, issue a log (with trace) for every `try_compile` noting what directory is being used for the compilation. This will make it easier to find the corresponding artifacts. Closes: #24022
* | Help: Disambiguate cmake(1) program modes in Sphinx option referencesBrad King2022-10-051-5/+37
|/ | | | | | Define the entry point to each mode as an option for the `cmake` program, but reference the options for that mode as part of stand-in `cmake-<mode>` programs.
* Help: Improve try_compile debug documentationMatthew Woehlke2022-10-031-9/+13
| | | | | | Update the --debug-trycompile documentation to account for recent changes to try_compile. Mention where in the build tree to find artifacts when using said option.
* cmake: Add --workflow modeKyle Edwards2022-09-271-0/+22
| | | | Fixes: #23118
* Merge topic 'cmake-presets-package'Brad King2022-09-021-3/+3
|\ | | | | | | | | | | | | | | | | | | a8d73085f4 CPack: Add support for presets b699610df4 cmCMakePresetsGraph: Add package presets 215b9148eb CMakePresets.json: Fix formatting of --list-presets=all Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !7621
| * CPack: Add support for presetsKyle Edwards2022-08-311-3/+3
| | | | | | | | Fixes: #23117
* | Merge topic 'E-capabilities-tls'Brad King2022-09-021-0/+5
|\ \ | |/ |/| | | | | | | | | | | d0bb3286f0 cmake -E capabilities: Tell whether TLS is enabled Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !7593
| * cmake -E capabilities: Tell whether TLS is enabledKyle Edwards2022-09-011-0/+5
| | | | | | | | Fixes: #20507
* | Merge topic 'feature/cmake-man-page-short-option-first'Brad King2022-08-191-1/+1
|\ \ | |/ |/| | | | | | | | | 536a25fedc Help: Convenient declaration for `-j, --parallel` option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7588
| * Help: Convenient declaration for `-j, --parallel` optionAlex Turbov2022-08-181-1/+1
| |
* | cmake -E env: Add --modify flagAlex Reinking2022-08-171-2/+20
|/ | | | | | | | | | | | | | | | | | | | | | When `cmake -E env` is given the `--modify` flag, try to parse the following argument as an `ENVIRONMENT_MODIFICATION` operation and apply it to the environment. This generalizes `--unset=`: 1. When implementing `ENVIRONMENT_MODIFICATION` features for other CMake commands, the `MYVAR=OP:VALUE` strings do not need to be translated to OP-specific flags. 2. This provides a natural and consistent extension point to introduce new operations without introducing very many flags. 3. Users need to learn only one syntax to access the same functionality. There is one difference between the behavior here as compared to CTest's interpretation of the `ENVIRONMENT_MODIFICATION` test property. The `MYVAR=reset:` command when run in `cmake -E env` will reset `MYVAR` to whatever its value was when `cmake -E env` launched, rather than try to checkpoint after plain `MYVAR=VALUE` options. This makes `MYVAR=VALUE` and `--modify MYVAR=set:VALUE` semantically equivalent.
* Help: Use placeholder instead of listing choices in option linesAlex Turbov2022-08-141-7/+10
| | | | | This avoids any ambiguity with whether the choices are literal values or not. It also makes the option lines more concise.
* Help: Simplify `cmake --log-level` option definitionAlex Turbov2022-08-141-3/+4
|
* Help: Simplify optional repeating optionAlex Turbov2022-08-141-2/+2
| | | | Similar form has already been used in the `ctest -M <mode> [-T <step>]...` synopsis and looks quite clean w/o extra characters.
* Help: Short options first, then long, then Windows styleAlex Turbov2022-08-141-1/+1
|
* Help: `{<…> | <…>}` → `<…|…>`Alex Turbov2022-08-141-2/+1
| | | | | The form of alternative names for "placeholders" has been used already (e.g., `<file|dir>` in the `cmake(1)` manual).
* Help: Consistent options declaration -- short first, then longAlex Turbov2022-08-041-1/+1
|
* Help: Value for `--graphviz=` option actually is mandatoryAlex Turbov2022-08-041-1/+1
| | | | Before it was `[file]` that AFAIK means optional.
* Help: Replace a bunch of more ``--option`` to `:option:` roleAlex Turbov2022-08-041-5/+8
|
* Help: Turn some mentions of options into links on executables man pageAlex Turbov2022-08-041-16/+22
|
* Help: Use `option` directive for the executables manual pagesAlex Turbov2022-08-041-87/+180
| | | | | | | It'll allow to refer to a particular option of any executable. There are two "fake" programs added for the CMake script mode (`cmake_P`) and CMake CLI Tool mode (`cmake_E`).
* Add cmake_language(GET_MESSAGE_LOG_LEVEL) sub commandAlexandru Croitor2022-06-281-0/+5
| | | | | | | | | | | | | | | | | The new sub-command writes a string representation of the current log level to the output variable given to the sub-command. Given that the log-level might be set either via the --log-level command line option or via the CMAKE_MESSAGE_LOG_LEVEL cache / regular variables, the priority for each of the log level sources is as follows, with the first one being the highest: 1) --log-level 2) CMAKE_MESSAGE_LOG_LEVEL regular variable 3) CMAKE_MESSAGE_LOG_LEVEL cache variable 4) default log level (STATUS) Fixes: #23572
* Merge topic 'ignore-werror-command-arg'Brad King2022-05-191-0/+5
|\ | | | | | | | | | | | | 65f7053d6c COMPILE_WARNING_AS_ERROR: Add command-line option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7268
| * COMPILE_WARNING_AS_ERROR: Add command-line optionMartin Duffy2022-05-181-0/+5
| | | | | | | | | | | | | | Add command-line option `--compile-no-warning-as-error` to ignore value of `COMPILE_WARNING_AS_ERROR`. Issue: #19085
* | Merge topic 'HelpExit'Brad King2022-05-051-0/+12
|\ \ | | | | | | | | | | | | | | | | | | | | | 0aea13d20b Help: for message(FATAL_ERROR), document nonzero exit code cc97725137 Help: document exit code of command cmake(1) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7175
| * | Help: for message(FATAL_ERROR), document nonzero exit codeJoachim Wuttke (h)2022-05-051-2/+3
| | |
| * | Help: document exit code of command cmake(1)Joachim Wuttke (h)2022-05-041-0/+11
| |/
* | Help: From Environment Variables section, link to cmake -E env etcJoachim Wuttke (h)2022-05-051-0/+2
|/
* Merge topic 'cmake-fresh'Brad King2022-03-251-0/+7
|\ | | | | | | | | | | | | | | 9f1471739d cmake: Add --fresh option to clear the cache and start from scratch Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !7099
| * cmake: Add --fresh option to clear the cache and start from scratchBrad King2022-03-221-0/+7
| | | | | | | | | | | | | | Simplify the workflow to re-run CMake from scratch as if a build tree were never before processed, regardless of whether it has been. Fixes: #23119
generated by cgit v0.12 at 2025-01-21 17:36:13 (GMT)