Re: [PATCH v2 11/11] setup: allow "git init --ref-storage-format=" to specify a payload
- From
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
- Date
- Sep 9, 2026, 08:54 UTC
- Message-ID
- <b2e0b347-5847-4ed8-bef9-441fc4dccd8e@gmail.com>
- In-Reply-To
- <20260907-b4-pks-unify-ref-storage-format-v2-11-6733c90ca5b0@pks.im>
On 9/7/26 16:48, Patrick Steinhardt wrote:
Show 20 quoted lines
> > diff --git a/Documentation/ref-storage-format.adoc b/Documentation/ref-storage-format.adoc > index c5e29ec831..21d62557b7 100644 > --- a/Documentation/ref-storage-format.adoc > +++ b/Documentation/ref-storage-format.adoc > @@ -1,8 +1,12 @@ > -`files`;; for loose files with packed-refs. > +`files[://<path>]`;; for loose files with packed-refs. The optional payload can > +be specified to change the root directory where references are created. A > +relative path will be resolved relative to the repository's common directory. > ifndef::with-breaking-changes[] > This is the default. > endif::with-breaking-changes[] > -`reftable`;; for the reftable format. > +`reftable[://<path>]`;; for the reftable format. The optional payload can > +be specified to change the root directory where references are created. A > +relative path will be resolved relative to the repository's common directory. > ifdef::with-breaking-changes[] > This is the default. > endif::with-breaking-changes[]
I think we need to be a bit more careful when modifying this ascii doc. This is also included in Documentation/git-refs.adoc and Documentation/git-repo.adoc.
We need to check if support should also be added to the former. For the latter, I think the inclusion may be fine since it is only for informational purposes.
Rest of the patch looks good to me.
-- Sivaraam