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>
Junio C Hamano committed
Dec 20, 2024 at 10:02 UTC
49edce4ff96d003e2b50202105107ef42e1f730e
2 files changed
+2
-2
Documentation/git-show-index.txt
+1
-1
@@ -9,7 +9,7 @@ git-show-index - Show packed archive index
9
SYNOPSIS
10
--------
11
[verse]
12
-'git show-index' [--object-format=<hash-algorithm>]
12
+'git show-index' [--object-format=<hash-algorithm>] < <pack-idx-file>
13
14
15
DESCRIPTION
builtin/show-index.c
+1
-1
@@ -7,7 +7,7 @@
7
#include "parse-options.h"
8
9
static const char *const show_index_usage[] = {
10
- "git show-index [--object-format=<hash-algorithm>]",
10
+ "git show-index [--object-format=<hash-algorithm>] < <pack-idx-file>",
11
NULL
12
};
13