summaryrefslogtreecommitdiff
path: root/Documentation/config/advice.txt
diff options
context:
space:
mode:
authorJeff Hostetler <jeffhost@microsoft.com>2019-06-18 20:21:27 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-06-21 16:35:02 (GMT)
commit0a53561a6221f989b210797e62e83fb7260fa42c (patch)
treecee0de1cd4a6583ab2e99c249707b0d6c8fc5961 /Documentation/config/advice.txt
parent06b324c1d71411cdd31da03da9e85b1880ef1c4b (diff)
downloadgit-0a53561a6221f989b210797e62e83fb7260fa42c.zip
git-0a53561a6221f989b210797e62e83fb7260fa42c.tar.gz
git-0a53561a6221f989b210797e62e83fb7260fa42c.tar.bz2
status: warn when a/b calculation takes too long
The ahead/behind calculation in 'git status' can be slow in some cases. Users may not realize that there are ways to avoid this computation, especially if they are not using the information. Add a warning that appears if this calculation takes more than two seconds. The warning can be disabled through the new config setting advice.statusAheadBehind. Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com> Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/advice.txt')
-rw-r--r--Documentation/config/advice.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
index ec4f6ae..4bc5b4c 100644
--- a/Documentation/config/advice.txt
+++ b/Documentation/config/advice.txt
@@ -37,6 +37,12 @@ advice.*::
we can still suggest that the user push to either
refs/heads/* or refs/tags/* based on the type of the
source object.
+ statusAheadBehind::
+ Shown when linkgit:git-status[1] computes the ahead/behind
+ counts for a local ref compared to its remote tracking ref,
+ and that calculation takes longer than expected. Will not
+ appear if `status.aheadBehind` is false or the option
+ `--no-ahead-behind` is given.
statusHints::
Show directions on how to proceed from the current
state in the output of linkgit:git-status[1], in