Code

docs: brush up obsolete bits of git-fsck manpage
authorJeff King <peff@peff.net>
Fri, 16 Dec 2011 11:33:10 +0000 (06:33 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sat, 17 Dec 2011 00:24:35 +0000 (16:24 -0800)
commit28303082609cb7efbdac87d45bf3a18c80eb8e70
tree1d8b92cebd2ac0b3122c65c832469bf168de5291
parent7b6c5836cf02999955b68c79f1cf2d13040acbc3
docs: brush up obsolete bits of git-fsck manpage

After the description and options, the fsck manpage contains
some discussion about what it does. Over time, this
discussion has become somewhat obsolete, both in content and
formatting. In particular:

  1. There are many options now, so starting the discussion
     with "It tests..." makes it unclear whether we are
     talking about the last option, or about the tool in
     general. Let's start a new "discussion" section and
     make our antecedent more clear.

  2. It gave an example for --unreachable using for-each-ref
     to mention all of the heads, saying that it will do "a
     _lot_ of verification". This is hopelessly out-of-date,
     as giving no arguments will check much more (reflogs,
     the index, non-head refs).

  3. It goes on to mention tests "to be added" (like tree
     object sorting). We now have these tests.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-fsck.txt