From: Linus Torvalds <torvalds@ppc970.osdl.org>
Date: Sun, 22 May 2005 21:32:26 +0000 (-0700)
Subject: Fix up git-fsck-cache documentation
X-Git-Tag: v0.99~495
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=6f97a894d6fe78c9ae24a128e6b93765b4cc76ff;p=git.git

Fix up git-fsck-cache documentation

Notably, the "--unreachable" flag no longer depends on specified heads,
and we should document what happens if no heads are given.
---

diff --git a/Documentation/git-fsck-cache.txt b/Documentation/git-fsck-cache.txt
index c05b1bfd9..ff97504cd 100644
--- a/Documentation/git-fsck-cache.txt
+++ b/Documentation/git-fsck-cache.txt
@@ -9,7 +9,7 @@ git-fsck-cache - Verifies the connectivity and validity of the objects in the da
 
 SYNOPSIS
 --------
-'git-fsck-cache' [--tags] [--root] [--delta-depth] [[--unreachable] [--cache] <object>\*]
+'git-fsck-cache' [--tags] [--root] [--delta-depth] [--unreachable] [--cache] [<object>*]
 
 DESCRIPTION
 -----------
@@ -20,9 +20,12 @@ OPTIONS
 <object>::
 	An object to treat as the head of an unreachability trace.
 
+	If no objects are given, git-fsck-cache defaults to using the
+	index file and all SHA1 references in .git/refs/* as heads.
+
 --unreachable::
 	Print out objects that exist but that aren't readable from any
-	of the specified head nodes.
+	of the reference nodes.
 
 --root::
 	Report root nodes.