[PATCH] Documentation: git-peek-remote.
[gitweb.git] / Documentation / git-fsck-cache.txt
index bcd3b0adcc4812f82c5caa45ec12564661828eb6..f1c18c10d82c63cab74779a4feacd2cde8671767 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] [[--unreachable] [--cache] <object>\*]
+'git-fsck-cache' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [<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.
@@ -34,6 +37,22 @@ OPTIONS
        Consider any object recorded in the cache also as a head node for
        an unreachability trace.
 
+--standalone::
+       Limit checks to the contents of GIT_OBJECT_DIRECTORY
+       (.git/objects), making sure that it is consistent and
+       complete without referring to objects found in alternate
+       object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,
+       nor packed GIT archives found in .git/objects/pack;
+       cannot be used with --full.
+
+--full::
+       Check not just objects in GIT_OBJECT_DIRECTORY
+       (.git/objects), but also the ones found in alternate
+       object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,
+       and in packed GIT archives found in .git/objects/pack
+       and corresponding pack subdirectories in alternate
+       object pools; cannot be used with --standalone.
+
 It tests SHA1 and general object sanity, and it does full tracking of
 the resulting reachability and everything else. It prints out any
 corruption it finds (missing or bad objects), and if you use the