show-index: the short help should say the command reads from its input

The short help text given by "git show-index -h" says

    $ git show-index -h
    usage: git show-index [--object-format=<hash-algorithm>]

        --[no-]object-format <hash-algorithm>
                              specify the hash algorithm to use

The command takes a pack .idx file from its standard input.  The
user has to _know_ this, as there is no indication from this output.

Give a hint that the data to work on is fed from its standard input.

Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt
index e49318a5a0aec7f46c6d23dbff5afcb920fae236..7e574ea243e58a6a660defb2a8f5d49c0475a29f 100644 (file)
--- a/Documentation/git-show-index.txt
+++ b/Documentation/git-show-index.txt
@@ -9,7 +9,7 @@ git-show-index - Show packed archive index
 SYNOPSIS
 --------
 [verse]
-'git show-index' [--object-format=<hash-algorithm>]
+'git show-index' [--object-format=<hash-algorithm>] < <pack-idx-file>
 
 
 DESCRIPTION

diff --git a/builtin/show-index.c b/builtin/show-index.c
index f164c01bbea4003ee97cdc4b3f7131b5b7def9ad..8678b741a47e67e5c7d3f9cd5793104a108048c9 100644 (file)
--- a/builtin/show-index.c
+++ b/builtin/show-index.c
@@ -7,7 +7,7 @@
 #include "parse-options.h"
 
 static const char *const show_index_usage[] = {
-       "git show-index [--object-format=<hash-algorithm>]",
+       "git show-index [--object-format=<hash-algorithm>] < <pack-idx-file>",
        NULL
 };