]> git.ipfire.org Git - thirdparty/git.git/commitdiff
bundle: document handling of "-" as stdin
authorJeff King <peff@peff.net>
Sat, 4 Mar 2023 10:26:40 +0000 (05:26 -0500)
committerJunio C Hamano <gitster@pobox.com>
Mon, 6 Mar 2023 21:12:56 +0000 (13:12 -0800)
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>
Documentation/git-bundle.txt

index 18a022b4b40c345040c23e83bed1fd1983bd725e..d19f4cf2b3c54a48dcc20df10b53e276a9591dc7 100644 (file)
@@ -66,7 +66,7 @@ create [options] <file> <git-rev-list-args>::
        Used to create a bundle named 'file'.  This requires the
        '<git-rev-list-args>' arguments to define the bundle contents.
        'options' contains the options specific to the 'git bundle create'
-       subcommand.
+       subcommand. If 'file' is `-`, the bundle is written to stdout.
 
 verify <file>::
        Used to check that a bundle file is valid and will apply
@@ -77,12 +77,13 @@ verify <file>::
        Finally, information about additional capabilities, such as "object
        filter", is printed. See "Capabilities" in linkgit:gitformat-bundle[5]
        for more information. The exit code is zero for success, but will
-       be nonzero if the bundle file is invalid.
+       be nonzero if the bundle file is invalid. If 'file' is `-`, the
+       bundle is read from stdin.
 
 list-heads <file>::
        Lists the references defined in the bundle.  If followed by a
        list of references, only references matching those given are
-       printed out.
+       printed out. If 'file' is `-`, the bundle is read from stdin.
 
 unbundle <file>::
        Passes the objects in the bundle to 'git index-pack'
@@ -90,6 +91,7 @@ unbundle <file>::
        defined references. If a list of references is given, only
        references matching those in the list are printed. This command is
        really plumbing, intended to be called only by 'git fetch'.
+       If 'file' is `-`, the bundle is read from stdin.
 
 <git-rev-list-args>::
        A list of arguments, acceptable to 'git rev-parse' and