summaryrefslogtreecommitdiffstats
path: root/src/doc/man/includes/options-timings.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:47:55 +0000
commit2aadc03ef15cb5ca5cc2af8a7c08e070742f0ac4 (patch)
tree033cc839730fda84ff08db877037977be94e5e3a /src/doc/man/includes/options-timings.md
parentInitial commit. (diff)
downloadcargo-upstream.tar.xz
cargo-upstream.zip
Adding upstream version 0.70.1+ds1.upstream/0.70.1+ds1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/doc/man/includes/options-timings.md')
-rw-r--r--src/doc/man/includes/options-timings.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/doc/man/includes/options-timings.md b/src/doc/man/includes/options-timings.md
new file mode 100644
index 0000000..d4e5998
--- /dev/null
+++ b/src/doc/man/includes/options-timings.md
@@ -0,0 +1,16 @@
+{{#option "`--timings=`_fmts_"}}
+Output information how long each compilation takes, and track concurrency
+information over time. Accepts an optional comma-separated list of output
+formats; `--timings` without an argument will default to `--timings=html`.
+Specifying an output format (rather than the default) is unstable and requires
+`-Zunstable-options`. Valid output formats:
+
+- `html` (unstable, requires `-Zunstable-options`): Write a human-readable file `cargo-timing.html` to the
+ `target/cargo-timings` directory with a report of the compilation. Also write
+ a report to the same directory with a timestamp in the filename if you want
+ to look at older runs. HTML output is suitable for human consumption only,
+ and does not provide machine-readable timing data.
+- `json` (unstable, requires `-Zunstable-options`): Emit machine-readable JSON
+ information about timing information.
+{{/option}}
+