aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/config-options.md
diff options
context:
space:
mode:
authorMatthias Sohn <matthias.sohn@sap.com>2023-11-08 02:49:23 +0100
committerMatthias Sohn <matthias.sohn@sap.com>2023-11-08 02:49:23 +0100
commit38344badf442afa1f6e8ee45c54e95d939efa868 (patch)
treefd9bb7402c2a8e54740018b4e740b10dd10e74c9 /Documentation/config-options.md
parent8e9eab7990f51d20ddbea64f26448cde29538c00 (diff)
downloadjgit-38344badf442afa1f6e8ee45c54e95d939efa868.tar.gz
jgit-38344badf442afa1f6e8ee45c54e95d939efa868.zip
Document GIT_TRACE_PERFORMANCE to show timings
Change-Id: I5a39b072c50e64a2d940680ed85866edfe9d0d28
Diffstat (limited to 'Documentation/config-options.md')
-rw-r--r--Documentation/config-options.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/Documentation/config-options.md b/Documentation/config-options.md
index e84dbd5649..84c4f5a664 100644
--- a/Documentation/config-options.md
+++ b/Documentation/config-options.md
@@ -132,4 +132,20 @@ Proxy configuration uses the standard Java mechanisms via class `java.net.ProxyS
| option | default | git option | description |
|---------|---------|------------|-------------|
-| `repack.packKeptObjects` | `true` when `pack.buildBitmaps` is set, `false` otherwise | &#x2705; | Include objects in packs locked by a `.keep` file when repacking. | \ No newline at end of file
+| `repack.packKeptObjects` | `true` when `pack.buildBitmaps` is set, `false` otherwise | &#x2705; | Include objects in packs locked by a `.keep` file when repacking. |
+
+## Tracing
+
+**GIT_TRACE_PERFORMANCE**: set this to `true` as a Java system property or environment variable to trace timings from the progress monitor. The system property takes
+precedence. Defaults to `false`. Can also be set programmatically via `ProgressMonitor#showDuration`.
+
+*Example using JGit CLI:*
+
+```bash
+$ GIT_TRACE_PERFORMANCE=true jgit clone https://foo.bar/foobar
+Cloning into 'foobar'...
+remote: Counting objects: 1 [0.002s]
+remote: Finding sources: 100% (15531/15531) [0.006s]
+Receiving objects: 100% (169737/169737) [13.045s]
+Resolving deltas: 100% (67579/67579) [1.842s]
+```