[PATCH 2/5] bundle: document handling of "-" as stdin
- From
Jeff King <peff@peff.net>
- Date
- Mar 4, 2023, 10:26 UTC
- Message-ID
- <ZAMc4DPOSjqxY/UT@coredump.intra.peff.net>
- In-Reply-To
- <ZAMb8LSpm2gOrpeY@coredump.intra.peff.net>
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> --- Arguably could be squashed into the previous patch, but the bit for "create" is weird then.
Documentation/git-bundle.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index 18a022b4b40..d19f4cf2b3c 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -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,19 +77,21 @@ 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' for storage in the repository, then prints the names of all 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
-- 2.40.0.rc1.500.g967c04631e