[PATCH] don't mention index refreshing side effect in git-status docs

From: Jeff King <peff@peff.net>
Date: Dec 9, 2007, 08:21 UTC
Message-ID: <20071209082133.GA2257@coredump.intra.peff.net>

The tip about speeding up subsequent operations is now obsolete; since aecbf914, git-diff now squelches empty diffs and performs an automatic refresh.

Signed-off-by: Jeff King <peff@peff.net>
---
This is on top of my other patches to the git-status docs.

I don't see any reason to mention this side effect at all. Those who know enough to set diff.autorefreshindex presumably know what they are doing, and the removed paragraph is a bit confusing to those who don't.

If there is some desire to document the side effect, I think we should at least remove the mention of speeding up git-diff (which is just wrong now).

 Documentation/git-status.txt |    7 -------
 1 files changed, 0 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index a1bb9bd..5c5a480 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -28,13 +28,6 @@ If there is no path that is different between the index file and
 the current HEAD commit (i.e., there is nothing to commit by running
 `git-commit`), the command exits with non-zero status.
 
-If any paths have been touched in the working tree (that is,
-their modification times have changed) but their contents and
-permissions are identical to those in the index file, the command
-updates the index file. Running `git-status` can thus speed up
-subsequent operations such as `git-diff` if the working tree
-contains many paths that have been touched but not modified.
-
 
 OUTPUT
 ------

-- 
1.5.3.7.2187.gb646