Re: [PATCH 2/4] Documentation/git-bundle.txt: mention full backup example

[Taylor Blau <me@ttaylorr.com>]

On Sun, Oct 20, 2024 at 09:15:00PM +0200, kristofferhaugsbakk@fastmail.com wrote:
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Tell the user how to make a full backup of the repository right at the
> start of the doc.
>
> This is a requested use-case.[1]  But the doc is a bit unassuming
> about it:
>
>   “ If you want to match `git clone --mirror`, which would include your
>     refs such as `refs/remotes/*`, use `--all`.
>
> The user cannot be expected to formulate “I want a full backup” as “I
> want to match `git clone --mirror`” for a bundle file or something.
>
> 🔗 1: https://stackoverflow.com/a/5578292/1725151

We do not typically use emoji characters in commit messages on the Git
project. The convention here would be to write this as

    [1]: https://stackoverflow.com/a/5578292/1725151

> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>  Documentation/git-bundle.txt | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
> index 7579dd309ac..bf0d448a736 100644
> --- a/Documentation/git-bundle.txt
> +++ b/Documentation/git-bundle.txt
> @@ -26,6 +26,9 @@ They can be used to create both incremental and full backups of a
>  repository, and to relay the state of the references in one repository
>  to another.
>
> +You can use `git bundle create <file> --all` to create a full backup of
> +your repository.
> +

Looks good, and could likely be combined with the previous paragraph
instead of breaking and starting a new one.

Now that you mention it here, does it make sense to drop the more subtle
mention that you refer to in the patch message?

Thanks,
Taylor