From 0e5168fd18f3975d71d3a292b0e0df174bb884d5 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Mon, 25 May 2009 06:33:15 -0400 Subject: [PATCH] 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 specifier in the usage to . That's what the documentation uses, and it does actually use the regular object lookup. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/git-cat-file.txt | 4 ++-- builtin-cat-file.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index b191276d7..58c8d6577 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -9,8 +9,8 @@ git-cat-file - Provide content or type and size information for repository objec SYNOPSIS -------- [verse] -'git cat-file' [-t | -s | -e | -p | ] -'git cat-file' [--batch | --batch-check] < +'git cat-file' (-t | -s | -e | -p | ) +'git cat-file' (--batch | --batch-check) < DESCRIPTION ----------- diff --git a/builtin-cat-file.c b/builtin-cat-file.c index 8fad19dae..43ffe7ffa 100644 --- a/builtin-cat-file.c +++ b/builtin-cat-file.c @@ -201,8 +201,8 @@ static int batch_objects(int print_contents) } static const char * const cat_file_usage[] = { - "git cat-file [-t|-s|-e|-p|] ", - "git cat-file [--batch|--batch-check] < ", + "git cat-file (-t|-s|-e|-p|) ", + "git cat-file (--batch|--batch-check) < ", NULL }; -- 2.30.2