Fix up git-fsck-cache documentation
authorLinus Torvalds <torvalds@ppc970.osdl.org>
Sun, 22 May 2005 21:32:26 +0000 (14:32 -0700)
committerLinus Torvalds <torvalds@ppc970.osdl.org>
Sun, 22 May 2005 21:32:26 +0000 (14:32 -0700)
Notably, the "--unreachable" flag no longer depends on specified heads,
and we should document what happens if no heads are given.

Documentation/git-fsck-cache.txt

index c05b1bfd991c583afbe54d1fa2a8ffc010eaf283..ff97504cd6b0d6da8f686b4b5c22f96a7888e6c1 100644 (file)
@@ -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.