Documentation / git-fsck-cache.txton commit git-send-pack: Fix duplicate refname match (e33b2ef)
   1git-fsck-cache(1)
   2=================
   3v0.1, May 2005
   4
   5NAME
   6----
   7git-fsck-cache - Verifies the connectivity and validity of the objects in the database
   8
   9
  10SYNOPSIS
  11--------
  12'git-fsck-cache' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [<object>*]
  13
  14DESCRIPTION
  15-----------
  16Verifies the connectivity and validity of the objects in the database.
  17
  18OPTIONS
  19-------
  20<object>::
  21        An object to treat as the head of an unreachability trace.
  22
  23        If no objects are given, git-fsck-cache defaults to using the
  24        index file and all SHA1 references in .git/refs/* as heads.
  25
  26--unreachable::
  27        Print out objects that exist but that aren't readable from any
  28        of the reference nodes.
  29
  30--root::
  31        Report root nodes.
  32
  33--tags::
  34        Report tags.
  35
  36--cache::
  37        Consider any object recorded in the cache also as a head node for
  38        an unreachability trace.
  39
  40--standalone::
  41        Limit checks to the contents of GIT_OBJECT_DIRECTORY
  42        (.git/objects), making sure that it is consistent and
  43        complete without referring to objects found in alternate
  44        object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,
  45        nor packed GIT archives found in .git/objects/pack;
  46        cannot be used with --full.
  47
  48--full::
  49        Check not just objects in GIT_OBJECT_DIRECTORY
  50        (.git/objects), but also the ones found in alternate
  51        object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,
  52        and in packed GIT archives found in .git/objects/pack
  53        and corresponding pack subdirectories in alternate
  54        object pools; cannot be used with --standalone.
  55
  56It tests SHA1 and general object sanity, and it does full tracking of
  57the resulting reachability and everything else. It prints out any
  58corruption it finds (missing or bad objects), and if you use the
  59'--unreachable' flag it will also print out objects that exist but
  60that aren't readable from any of the specified head nodes.
  61
  62So for example
  63
  64        git-fsck-cache --unreachable $(cat .git/HEAD)
  65
  66or, for Cogito users:
  67
  68        git-fsck-cache --unreachable $(cat .git/refs/heads/*)
  69
  70will do quite a _lot_ of verification on the tree. There are a few
  71extra validity tests to be added (make sure that tree objects are
  72sorted properly etc), but on the whole if "git-fsck-cache" is happy, you
  73do have a valid tree.
  74
  75Any corrupt objects you will have to find in backups or other archives
  76(ie you can just remove them and do an "rsync" with some other site in
  77the hopes that somebody else has the object you have corrupted).
  78
  79Of course, "valid tree" doesn't mean that it wasn't generated by some
  80evil person, and the end result might be crap. Git is a revision
  81tracking system, not a quality assurance system ;)
  82
  83Extracted Diagnostics
  84---------------------
  85
  86expect dangling commits - potential heads - due to lack of head information::
  87        You haven't specified any nodes as heads so it won't be
  88        possible to differentiate between un-parented commits and
  89        root nodes.
  90
  91missing sha1 directory '<dir>'::
  92        The directory holding the sha1 objects is missing.
  93
  94unreachable <type> <object>::
  95        The <type> object <object>, isn't actually referred to directly
  96        or indirectly in any of the trees or commits seen. This can
  97        mean that there's another root node that you're not specifying
  98        or that the tree is corrupt. If you haven't missed a root node
  99        then you might as well delete unreachable nodes since they
 100        can't be used.
 101
 102missing <type> <object>::
 103        The <type> object <object>, is referred to but isn't present in
 104        the database.
 105
 106dangling <type> <object>::
 107        The <type> object <object>, is present in the database but never
 108        'directly' used. A dangling commit could be a root node.
 109
 110warning: git-fsck-cache: tree <tree> has full pathnames in it::
 111        And it shouldn't...
 112
 113sha1 mismatch <object>::
 114        The database has an object who's sha1 doesn't match the
 115        database value.
 116        This indicates a serious data integrity problem.
 117        (note: this error occured during early git development when
 118        the database format changed.)
 119
 120Environment Variables
 121---------------------
 122
 123GIT_OBJECT_DIRECTORY::
 124        used to specify the object database root (usually .git/objects)
 125
 126GIT_INDEX_FILE::
 127        used to specify the cache
 128
 129
 130Author
 131------
 132Written by Linus Torvalds <torvalds@osdl.org>
 133
 134Documentation
 135--------------
 136Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 137
 138GIT
 139---
 140Part of the link:git.html[git] suite
 141