diff mbox series

[1/4] Documentation/git-bundle.txt: mention --all in Synopsis

Message ID 39bdc5941c7b53c432966984fa79b81fde978e86.1729451376.git.code@khaugsbakk.name (mailing list archive)
State New
Headers show
Series Documentation/git-bundle.txt: promote --all for full backup | expand

Commit Message

Kristoffer Haugsbakk Oct. 20, 2024, 7:14 p.m. UTC 
From: Kristoffer Haugsbakk <code@khaugsbakk.name>

`--all` is convenient for bundling all refs.  But it is only mentioned
once, halfway through the doc, under the demure section “Object
prerequisites”.  It deserves to be mentioned as an alternative to
`<git-rev-list-args>`.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    Long line in bundle.c now?

 Documentation/git-bundle.txt | 2 +-
 builtin/bundle.c             | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Kristoffer Haugsbakk Oct. 20, 2024, 7:33 p.m. UTC | #1 
On Sun, Oct 20, 2024, at 21:14, kristofferhaugsbakk@fastmail.com wrote:
> prerequisites”.  It deserves to be mentioned as an alternative to
> `<git-rev-list-args>`.

git-rev-list-args huh.

git-rev-lists(1) has `--all`.  That must be were it comes from to begin
with.

That’s why I kept looking for `--all` in all the wrong places.

This patch should be dropped.
Taylor Blau Oct. 21, 2024, 9:30 p.m. UTC | #2 
On Sun, Oct 20, 2024 at 09:33:39PM +0200, Kristoffer Haugsbakk wrote:
> On Sun, Oct 20, 2024, at 21:14, kristofferhaugsbakk@fastmail.com wrote:
> > prerequisites”.  It deserves to be mentioned as an alternative to
> > `<git-rev-list-args>`.
>
> git-rev-list-args huh.
>
> git-rev-lists(1) has `--all`.  That must be were it comes from to begin
> with.
>
> That’s why I kept looking for `--all` in all the wrong places.
>
> This patch should be dropped.

I was going to say... <git-rev-list-args> is a superset of {--all}. But
dropping this makes sense.

Thanks,
Taylor
diff mbox series

Patch

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 3ab42a19cae..7579dd309ac 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -10,7 +10,7 @@  SYNOPSIS
 --------
 [verse]
 'git bundle' create [-q | --quiet | --progress]
-		    [--version=<version>] <file> <git-rev-list-args>
+		    [--version=<version>] <file> (<git-rev-list-args> | --all)
 'git bundle' verify [-q | --quiet] <file>
 'git bundle' list-heads <file> [<refname>...]
 'git bundle' unbundle [--progress] <file> [<refname>...]
diff --git a/builtin/bundle.c b/builtin/bundle.c
index 127518c2a8d..6d610253575 100644
--- a/builtin/bundle.c
+++ b/builtin/bundle.c
@@ -17,7 +17,7 @@ 
 
 #define BUILTIN_BUNDLE_CREATE_USAGE \
 	N_("git bundle create [-q | --quiet | --progress]\n" \
-	   "                  [--version=<version>] <file> <git-rev-list-args>")
+	   "                  [--version=<version>] <file> (<git-rev-list-args> | --all)")
 #define BUILTIN_BUNDLE_VERIFY_USAGE \
 	N_("git bundle verify [-q | --quiet] <file>")
 #define BUILTIN_BUNDLE_LIST_HEADS_USAGE \