diff options
| author | Jeff King <peff@peff.net> | 2018-05-28 09:39:23 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-05-28 15:28:22 (GMT) |
| commit | fb3010c31fdaa00ae91152431c3da7e300daf848 (patch) | |
| tree | b0d8269767b8d4634b6066968886e7c696efcbc4 /Documentation/git-show-index.txt | |
| parent | ff417260cf36a73b7cb39b40e6c81e5313e28b9b (diff) | |
| download | git-fb3010c31fdaa00ae91152431c3da7e300daf848.zip git-fb3010c31fdaa00ae91152431c3da7e300daf848.tar.gz git-fb3010c31fdaa00ae91152431c3da7e300daf848.tar.bz2 | |
show-index: update documentation for index v2
Commit 32637cdf4a (show-index.c: learn about index v2,
2007-04-09) changed the output format of show-index to
include the object CRC32 but didn't update the
documentation. Let's fix that and generally describe the
output in more detail.
There are a few other fixes here while we're rewording:
- refer to index-pack along with pack-objects, since either
can create .idx files
- use "linkgit:" for referring to other commands
- expand the bit about verify-pack, giving reasons why you
might want this command instead. I almost omitted this
entirely, but referring to verify-pack might help a
reader who is looking for more information.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-show-index.txt')
| -rw-r--r-- | Documentation/git-show-index.txt | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt index a8a9509..424e4ba 100644 --- a/Documentation/git-show-index.txt +++ b/Documentation/git-show-index.txt @@ -14,13 +14,27 @@ SYNOPSIS DESCRIPTION ----------- -Read the idx file for a Git packfile created with -'git pack-objects' command from the standard input, and -dump its contents. +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 information it outputs is subset of what you can get from -'git verify-pack -v'; this command only shows the packfile -offset and SHA-1 of each object. + - 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. GIT --- |