mirror of
https://github.com/git/git.git
synced 2024-05-26 17:36:28 +02:00
fb3010c31f
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>
42 lines
1.0 KiB
Plaintext
42 lines
1.0 KiB
Plaintext
git-show-index(1)
|
|
=================
|
|
|
|
NAME
|
|
----
|
|
git-show-index - Show packed archive index
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git show-index'
|
|
|
|
|
|
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.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|