show-index: update documentation for index v2
commitfb3010c31fdaa00ae91152431c3da7e300daf848
authorJeff King <peff@peff.net>
Mon, 28 May 2018 09:39:23 +0000 (28 05:39 -0400)
committerJunio C Hamano <gitster@pobox.com>
Mon, 28 May 2018 15:28:22 +0000 (29 00:28 +0900)
treeb0d8269767b8d4634b6066968886e7c696efcbc4
parentff417260cf36a73b7cb39b40e6c81e5313e28b9b
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>
Documentation/git-show-index.txt