diff options
Diffstat (limited to 'Help/manual/cmake-presets.7.rst')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index da699d86af..7794e45ce5 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -63,6 +63,9 @@ The root object recognizes the following fields: ``6`` .. versionadded:: 3.25 + ``7`` + .. versionadded:: 3.27 + ``cmakeMinimumRequired`` An optional object representing the minimum version of CMake needed to build this project. This object consists of the following fields: @@ -359,6 +362,52 @@ that may contain the following fields: An optional boolean. Setting this to ``true`` is equivalent to passing :option:`--debug-find <cmake --debug-find>` on the command line. +``trace`` + An optional object specifying trace options. This is allowed in preset + files specifying version ``7``. The object may contain the following fields: + + ``mode`` + An optional string that specifies the trace mode. Valid values are: + + ``on`` + Causes a trace of all calls made and from where to be printed. + Equivalent to passing :option:`--trace <cmake --trace>` on the command + line. + + ``off`` + A trace of all calls will not be printed. + + ``expand`` + Causes a trace with variables expanded of all calls made and from where + to be printed. Equivalent to passing :option:`--trace-expand <cmake --trace-expand>` + on the command line. + + ``format`` + An optional string that specifies the format output of the trace. + Valid values are: + + ``human`` + Prints each trace line in a human-readable format. + This is the default format. Equivalent to passing + :option:`--trace-format=human <cmake --trace-format>` + on the command line. + + ``json-v1`` + Prints each line as a separate JSON document. Equivalent to passing + :option:`--trace-format=json-v1 <cmake --trace-format>` + on the command line. + + ``source`` + An optional array of strings representing the paths of source files to + be traced. This field can also be a string, which is equivalent to an + array containing one string. Equivalent to passing + :option:`--trace-source <cmake --trace-source>` on the command line. + + ``redirect`` + An optional string specifying a path to a trace output file. Equivalent + to passing :option:`--trace-redirect <cmake --trace-redirect>` + on the command line. + Build Preset ^^^^^^^^^^^^ |