author | Jeff King <peff@peff.net> | |
Mon, 25 May 2009 10:33:15 +0000 (06:33 -0400) | ||
committer | Junio C Hamano <gitster@pobox.com> | |
Mon, 25 May 2009 19:08:15 +0000 (12:08 -0700) | ||
commit | 0e5168fd18f3975d71d3a292b0e0df174bb884d5 | |
tree | bbeb407f4d5fc43c3674be1968699da7955de118 | tree | snapshot |
parent | fa250759794ab98e6edfbbf2f6aa2cb912e535eb | commit | diff |
fix cat-file usage message and documentation
cat-file with an object on the command line requires an
option to tell it what to output (type, size, pretty-print,
etc). However, the square brackets in the usage imply that
those options are not required. This patch switches them to
parentheses to indicate "required but grouped-OR" (curly
braces might also work, but this follows the convention used
already by "git stash").
While we're at it, let's change the <sha1> specifier in the
usage to <object>. That's what the documentation uses, and
it does actually use the regular object lookup.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
cat-file with an object on the command line requires an
option to tell it what to output (type, size, pretty-print,
etc). However, the square brackets in the usage imply that
those options are not required. This patch switches them to
parentheses to indicate "required but grouped-OR" (curly
braces might also work, but this follows the convention used
already by "git stash").
While we're at it, let's change the <sha1> specifier in the
usage to <object>. That's what the documentation uses, and
it does actually use the regular object lookup.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-cat-file.txt | diff | blob | history | |
builtin-cat-file.c | diff | blob | history |