From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 20 Dec 2024 18:02:15 +0000 (-0800)
Subject: show-index: the short help should say the command reads from its input
X-Git-Tag: v2.49.0-rc0~64^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=49edce4ff96d003e2b50202105107ef42e1f730e;p=thirdparty%2Fgit.git

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 e49318a5a0..7e574ea243 100644
--- 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 f164c01bbe..8678b741a4 100644
--- 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
 };