From: Jeff King <peff@peff.net>
Date: Fri, 19 Oct 2007 02:01:11 +0000 (-0400)
Subject: Documentation/git-gc: explain --auto in description
X-Git-Tag: v1.5.4-rc0~340
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=08fbb136f7440eac96f4e4396316aff36526f299;p=git.git

Documentation/git-gc: explain --auto in description

Now that git-gc --auto tells the user to look at the man
page, it makes sense to mention the auto behavior near the
top (since this is likely to be most users' first exposure
to git-gc).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---

diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index b9d5660ea..83843a549 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -19,7 +19,8 @@ created from prior invocations of gitlink:git-add[1].
 
 Users are encouraged to run this task on a regular basis within
 each repository to maintain good disk space utilization and good
-operating performance.
+operating performance. Some git commands may automatically run
+`git-gc`; see the `--auto` flag below for details.
 
 OPTIONS
 -------