From: Ramsay Jones <ramsay@ramsayjones.plus.com>
Date: Fri, 24 May 2024 18:24:32 GMT
Subject: Re: [PATCH v2 9/9] builtin/refs: new command to migrate ref storage formats
Message-ID: <54110fa9-02ba-4c9d-9ec2-c26e98a42730@ramsayjones.plus.com>
In-Reply-To: <0df17a51b43e1e9d007328aad6457363876b2e1d.1716545235.git.ps@pks.im>



On 24/05/2024 11:15, Patrick Steinhardt wrote:
[snip]
> diff --git a/Documentation/git-refs.txt b/Documentation/git-refs.txt
> new file mode 100644
> index 0000000000..3f73ad6aa6
> --- /dev/null
> +++ b/Documentation/git-refs.txt
> @@ -0,0 +1,62 @@
> +git-refs(1)
> +===========
> +
> +NAME
> +----
> +
> +git-refs - Low-level access to refs
> +
> +SYNOPSIS
> +--------
> +
> +[verse]
> +'git refs migrate' --ref-format=<format> [--dry-run]
> +
> +DESCRIPTION
> +-----------
> +
> +This command provides low-level access to refs.
> +
> +COMMANDS
> +--------
> +
> +migrate::
> +	Migrate ref store between different formats.
> +
> +OPTIONS
> +-------
> +
> +The following options are specific to 'git refs migrate':
> +
> +--ref-format=<format>::
> +	The ref format to migrate the ref store to. Can be one of:
> ++
> +include::ref-storage-format.txt[]
> +
> +--dry-run::
> +	Perform the migration, but do not modify the repository. The migrated
> +	refs will be written into a separate directory that can be inspected
> +	separately. The name of the directory will be reported on stdout. This
> +	can be used to double check that the migration works as expected doing
> +	performing the actual migration.

s/expected doing performing/expected before performing/ ?

ATB,
Ramsay Jones