Merge branch 'ps/do-not-trust-commit-graph-blindly-for-existence'

[thirdparty/git.git] / Documentation / git.txt

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 9aeabde26200e1585d8d5283b6cdbc85ef8a37dc..2535a30194f978af900c0f84228680b3b8edf93a 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -911,6 +911,16 @@ for full details.
        should not normally need to set this to `0`, but it may be
        useful when trying to salvage data from a corrupted repository.
 
+`GIT_COMMIT_GRAPH_PARANOIA`::
+       When loading a commit object from the commit-graph, Git performs an
+       existence check on the object in the object database. This is done to
+       avoid issues with stale commit-graphs that contain references to
+       already-deleted commits, but comes with a performance penalty.
++
+The default is "true", which enables the aforementioned behavior.
+Setting this to "false" disables the existence check. This can lead to
+a performance improvement at the cost of consistency.
+
 `GIT_ALLOW_PROTOCOL`::
        If set to a colon-separated list of protocols, behave as if
        `protocol.allow` is set to `never`, and each of the listed