bundle: document handling of "-" as stdin
We have always allowed "bundle create -" to write to stdout, but it was never documented. And a recent patch let reading operations like "bundle list-heads -" read from stdin. Let's document all of these cases. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Mar 4, 2023 at 05:26 UTC
ef3b291a5f19d7e3b7f4cc4524003e50d40614f7
1 file changed
+5
-3
Documentation/git-bundle.txt
+5
-3
@@ -66,7 +66,7 @@ create [options] <file> <git-rev-list-args>::
66
Used to create a bundle named 'file'. This requires the
67
'<git-rev-list-args>' arguments to define the bundle contents.
68
'options' contains the options specific to the 'git bundle create'
69
- subcommand.
69
+ subcommand. If 'file' is `-`, the bundle is written to stdout.
70
71
verify <file>::
72
Used to check that a bundle file is valid and will apply
@@ -77,12 +77,13 @@ verify <file>::
77
Finally, information about additional capabilities, such as "object
78
filter", is printed. See "Capabilities" in linkgit:gitformat-bundle[5]
79
for more information. The exit code is zero for success, but will
80
- be nonzero if the bundle file is invalid.
80
+ be nonzero if the bundle file is invalid. If 'file' is `-`, the
81
+ bundle is read from stdin.
82
83
list-heads <file>::
84
Lists the references defined in the bundle. If followed by a
85
list of references, only references matching those given are
85
- printed out.
86
+ printed out. If 'file' is `-`, the bundle is read from stdin.
87
88
unbundle <file>::
89
Passes the objects in the bundle to 'git index-pack'
@@ -90,6 +91,7 @@ unbundle <file>::
91
defined references. If a list of references is given, only
92
references matching those in the list are printed. This command is
93
really plumbing, intended to be called only by 'git fetch'.
94
+ If 'file' is `-`, the bundle is read from stdin.
95
96
<git-rev-list-args>::
97
A list of arguments, acceptable to 'git rev-parse' and