Merge branch 'jt/trace2-BUG'

[thirdparty/git.git] / Documentation / git-index-pack.txt

diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index af0c26232c1e775cf5f4d56ee67c07b6a73a9104..69ba904d4491957dcf739097e739357aa5969891 100644 (file)
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -9,17 +9,18 @@ git-index-pack - Build pack index file for an existing packed archive
 SYNOPSIS
 --------
 [verse]
-'git index-pack' [-v] [-o <index-file>] <pack-file>
+'git index-pack' [-v] [-o <index-file>] [--[no-]rev-index] <pack-file>
 'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
-                 [<pack-file>]
+                 [--[no-]rev-index] [<pack-file>]
 
 
 DESCRIPTION
 -----------
 Reads a packed archive (.pack) from the specified file, and
-builds a pack index file (.idx) for it.  The packed archive
-together with the pack index can then be placed in the
-objects/pack/ directory of a Git repository.
+builds a pack index file (.idx) for it. Optionally writes a
+reverse-index (.rev) for the specified pack. The packed
+archive together with the pack index can then be placed in
+the objects/pack/ directory of a Git repository.
 
 
 OPTIONS
@@ -35,6 +36,13 @@ OPTIONS
        fails if the name of packed archive does not end
        with .pack).
 
+--[no-]rev-index::
+       When this flag is provided, generate a reverse index
+       (a `.rev` file) corresponding to the given pack. If
+       `--verify` is given, ensure that the existing
+       reverse index is correct. Takes precedence over
+       `pack.writeReverseIndex`.
+
 --stdin::
        When this flag is provided, the pack is read from stdin
        instead and a copy is then written to <pack-file>. If