summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2025-05-15 10:53:32 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2025-05-15 13:22:02 +0200
commit36d4ee50c1285dfb7d12104bbd2a48b2cebcef45 (patch)
tree84435486ae5fceb26b60de1511a2cb03c9399e91 /doc
parent2d8a0b2f3d8cb546007e50c105a4cd0128b3e2d0 (diff)
downloadjustbuild-36d4ee50c1285dfb7d12104bbd2a48b2cebcef45.tar.gz
tutorial invocation logging: include --dump-artifacts
A typical invocation logging would also include a value for "--dump-artifacts". Mention this in the tutorial.
Diffstat (limited to 'doc')
-rw-r--r--doc/tutorial/invocation-logging.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/tutorial/invocation-logging.md b/doc/tutorial/invocation-logging.md
index b6eb4cba..a1f94a1c 100644
--- a/doc/tutorial/invocation-logging.md
+++ b/doc/tutorial/invocation-logging.md
@@ -48,6 +48,10 @@ be specified.
directory to be used when generating the `--profile` option in
the command line for the `just` invocation.
- `"--dump-graph"` does the same for the `--dump-graph` option.
+ - `"--dump-artifacts"` does the same for the `--dump-artifacts`
+ option; while not directly useful for profiling, browsing the
+ final artifacts (including the test logs) can be useful to
+ understand a particular invocation.
- `"metadata"` specifies a file name inside the invocation directory
a metadata file should be written by `just-mr`; that file
contains, in particular, the full command line that is executed
@@ -63,6 +67,7 @@ would look as follows.
, "metadata": "meta.json"
, "--profile": "profile.json"
, "--dump-graph": "graph.json"
+ , "--dump-artifacts": "artifacts.json"
}
}
```