Skip to content

Commit ef3b291

Browse files
peffgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bf8b1e0 commit ef3b291

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Documentation/git-bundle.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ create [options] <file> <git-rev-list-args>::
6666
Used to create a bundle named 'file'. This requires the
6767
'<git-rev-list-args>' arguments to define the bundle contents.
6868
'options' contains the options specific to the 'git bundle create'
69-
subcommand.
69+
subcommand. If 'file' is `-`, the bundle is written to stdout.
7070

7171
verify <file>::
7272
Used to check that a bundle file is valid and will apply
@@ -77,19 +77,21 @@ verify <file>::
7777
Finally, information about additional capabilities, such as "object
7878
filter", is printed. See "Capabilities" in linkgit:gitformat-bundle[5]
7979
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.
8182

8283
list-heads <file>::
8384
Lists the references defined in the bundle. If followed by a
8485
list of references, only references matching those given are
85-
printed out.
86+
printed out. If 'file' is `-`, the bundle is read from stdin.
8687

8788
unbundle <file>::
8889
Passes the objects in the bundle to 'git index-pack'
8990
for storage in the repository, then prints the names of all
9091
defined references. If a list of references is given, only
9192
references matching those in the list are printed. This command is
9293
really plumbing, intended to be called only by 'git fetch'.
94+
If 'file' is `-`, the bundle is read from stdin.
9395

9496
<git-rev-list-args>::
9597
A list of arguments, acceptable to 'git rev-parse' and

0 commit comments

Comments
 (0)