]> source.dussan.org Git - jgit.git/commitdiff
Document GIT_TRACE_PERFORMANCE to show timings 54/205354/1
authorMatthias Sohn <matthias.sohn@sap.com>
Wed, 8 Nov 2023 01:49:23 +0000 (02:49 +0100)
committerMatthias Sohn <matthias.sohn@sap.com>
Wed, 8 Nov 2023 01:49:23 +0000 (02:49 +0100)
Change-Id: I5a39b072c50e64a2d940680ed85866edfe9d0d28

Documentation/config-options.md

index e84dbd5649c5251fa527cb33fb626a3c7974b47d..84c4f5a664890dc1198f0de7c5aa7dc0cae4c689 100644 (file)
@@ -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]
+```