summaryrefslogtreecommitdiffstats
path: root/Documentation/git-show-index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-show-index.txt')
-rw-r--r--Documentation/git-show-index.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt
new file mode 100644
index 0000000..e49318a
--- /dev/null
+++ b/Documentation/git-show-index.txt
@@ -0,0 +1,52 @@
+git-show-index(1)
+=================
+
+NAME
+----
+git-show-index - Show packed archive index
+
+
+SYNOPSIS
+--------
+[verse]
+'git show-index' [--object-format=<hash-algorithm>]
+
+
+DESCRIPTION
+-----------
+Read the `.idx` file for a Git packfile (created with
+linkgit:git-pack-objects[1] or linkgit:git-index-pack[1]) from the
+standard input, and dump its contents. The output consists of one object
+per line, with each line containing two or three space-separated
+columns:
+
+ - the first column is the offset in bytes of the object within the
+ corresponding packfile
+
+ - the second column is the object id of the object
+
+ - if the index version is 2 or higher, the third column contains the
+ CRC32 of the object data
+
+The objects are output in the order in which they are found in the index
+file, which should be (in a correctly constructed file) sorted by object
+id.
+
+Note that you can get more information on a packfile by calling
+linkgit:git-verify-pack[1]. However, as this command considers only the
+index file itself, it's both faster and more flexible.
+
+OPTIONS
+-------
+
+--object-format=<hash-algorithm>::
+ Specify the given object format (hash algorithm) for the index file. The
+ valid values are 'sha1' and (if enabled) 'sha256'. The default is the
+ algorithm for the current repository (set by `extensions.objectFormat`), or
+ 'sha1' if no value is set or outside a repository..
++
+include::object-format-disclaimer.txt[]
+
+GIT
+---
+Part of the linkgit:git[1] suite