Documentation/git-multi-pack-index.txt

   1 git-multi-pack-index(1)
   2 =======================
   3
   4 NAME
   5 ----
   6 git-multi-pack-index - Write and verify multi-pack-indexes
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git multi-pack-index' [--object-dir=<dir>] <subcommand>
  13
  14 DESCRIPTION
  15 -----------
  16 Write or verify a multi-pack-index (MIDX) file.
  17
  18 OPTIONS
  19 -------
  20
  21 --object-dir=<dir>::
  22         Use given directory for the location of Git objects. We check
  23         `<dir>/packs/multi-pack-index` for the current MIDX file, and
  24         `<dir>/packs` for the pack-files to index.
  25
  26 The following subcommands are available:
  27
  28 write::
  29         Write a new MIDX file.
  30
  31 verify::
  32         Verify the contents of the MIDX file.
  33
  34 expire::
  35         Delete the pack-files that are tracked  by the MIDX file, but
  36         have no objects referenced by the MIDX. Rewrite the MIDX file
  37         afterward to remove all references to these pack-files.
  38
  39
  40 EXAMPLES
  41 --------
  42
  43 * Write a MIDX file for the packfiles in the current .git folder.
  44 +
  45 -----------------------------------------------
  46 $ git multi-pack-index write
  47 -----------------------------------------------
  48
  49 * Write a MIDX file for the packfiles in an alternate object store.
  50 +
  51 -----------------------------------------------
  52 $ git multi-pack-index --object-dir <alt> write
  53 -----------------------------------------------
  54
  55 * Verify the MIDX file for the packfiles in the current .git folder.
  56 +
  57 -----------------------------------------------
  58 $ git multi-pack-index verify
  59 -----------------------------------------------
  60
  61
  62 SEE ALSO
  63 --------
  64 See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
  65 Document] and link:technical/pack-format.html[The Multi-Pack-Index
  66 Format] for more information on the multi-pack-index feature.
  67
  68
  69 GIT
  70 ---
  71 Part of the linkgit:git[1] suite