Add a note about the index being updated by git-status in some cases

Signed-off-by: Steven Grimm <redacted>
Signed-off-by: Junio C Hamano <redacted>

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 6f16eb0328f754b5f5019ff5dac51604de7d535f..8fd0fc62368611bee25b4bbc3becef853937ff2c 100644 (file)
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -27,6 +27,13 @@ The command takes the same set of options as `git-commit`; it
 shows what would be committed if the same options are given to
 `git-commit`.
 
+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
 ------