diff options
| author | Brad King <brad.king@kitware.com> | 2020-03-13 14:58:44 +0000 |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-03-13 10:59:03 -0400 |
| commit | 1b5554e863b4f2a14bb327a6ae3a2ec40ae4af41 (patch) | |
| tree | 903d7e0f75d7dff19050a44bd8c385e3f7956ab5 /Help | |
| parent | c3ab1c22b069b64483a0525c3244e3377f256a87 (diff) | |
| parent | 9aa4640792bd99b232abfe826b0cb0ae72f6644a (diff) | |
| download | cmake-1b5554e863b4f2a14bb327a6ae3a2ec40ae4af41.tar.gz | |
Merge topic 'profiling'
9aa4640792 cmake: add command line options to output script profiling data
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Ben Boeckel <ben.boeckel@kitware.com>
Acked-by: Pavel Solodovnikov <hellyeahdominate@gmail.com>
Acked-by: Leonid Pospelov <pospelovlm@yandex.ru>
Acked-by: Cristian Adam <cristian.adam@gmail.com>
Merge-request: !2760
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake.1.rst | 14 | ||||
| -rw-r--r-- | Help/release/dev/profiling.rst | 9 |
2 files changed, 23 insertions, 0 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 44b1f2f8a1..429cba4b01 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -356,6 +356,20 @@ Options in :variable:`CMAKE_SOURCE_DIR` and :variable:`CMAKE_BINARY_DIR`. This flag tells CMake to warn about other files as well. +``--profiling-output=<path>`` + Used in conjuction with ``--profiling-format`` to output to a given path. + +``--profiling-format=<file>`` + Enable the output of profiling data of CMake script in the given format. + + This can aid performance analysis of CMake scripts executed. Third party + applications should be used to process the output into human readable format. + + Currently supported values are: + ``google-trace`` Outputs in Google Trace Format, which can be parsed by the + about:tracing tab of Google Chrome or using a plugin for a tool like Trace + Compass. + .. _`Build Tool Mode`: Build a Project diff --git a/Help/release/dev/profiling.rst b/Help/release/dev/profiling.rst new file mode 100644 index 0000000000..ab180f04d6 --- /dev/null +++ b/Help/release/dev/profiling.rst @@ -0,0 +1,9 @@ +cmake-profiling +--------------- + +* Add support for profiling of CMake scripts through the parameters + ``--profiling-output`` and ``--profiling-format``. These options can + be used by users to gain insight into the performance of their scripts. + + The first supported output format is ``google-trace`` which is a format + supported by Google Chrome's ``about:tracing`` tab. |