git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 11/11] setup: allow "git init --ref-storage-format=" to specify a payload

From
Patrick Steinhardt <ps@pks.im>
Date
Sep 9, 2026, 09:23 UTC
Message-ID
<aqEln6yto1xVNjqz@pks.im>
In-Reply-To
<b2e0b347-5847-4ed8-bef9-441fc4dccd8e@gmail.com>
On Wed, Sep 09, 2026 at 02:24:28PM +0530, Kaartic Sivaraam wrote:
Show 28 quoted lines
> On 9/7/26 16:48, Patrick Steinhardt wrote:
> > 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.

Yeha, for git-repo(1) it's a good change even, I'd argue. But for the former I'd also argue that git-refs(1) itself should learn to use URIs here. But that's a bigger change, and one that I'd rather avoid doing as part of this already-huge patch series.

You know, I'll probably keep this specific change out and only change documentation of git-init(1) and git-clone(1) for now.

Thanks!
Patrick
Previous: Kaartic Sivaraam
Message 27 of 27 in “Fix inconsistent ref storage format terminology”
  1. 00/11 Fix inconsistent ref storage format terminologyPatrick Steinhardt, Sep 7, 2026
  2. 01/11 builtin/init: rename "--ref-format=" to "--ref-storage-format="Patrick Steinhardt, Sep 7, 2026
  3. Kaartic SivaraamSep 8, 2026
  4. Patrick SteinhardtSep 9, 2026
  5. Kaartic SivaraamSep 9, 2026
  6. 02/11 builtin/clone: rename "--ref-format=" to "--ref-storage-format="Patrick Steinhardt, Sep 7, 2026
  7. Kaartic SivaraamSep 8, 2026
  8. Patrick SteinhardtSep 9, 2026
  9. 03/11 builtin/refs: rename "--ref-format=" to "--ref-storage-format="Patrick Steinhardt, Sep 7, 2026
  10. Kaartic SivaraamSep 8, 2026
  11. Patrick SteinhardtSep 9, 2026
  12. 04/11 builtin/submodule: rename "--ref-format=" to "--ref-storage-format="Patrick Steinhardt, Sep 7, 2026
  13. 05/11 builtin/rev-parse: rename "--show-ref-format" to "--show-ref-storage-format"Patrick Steinhardt, Sep 7, 2026
  14. 06/11 help: rename "default-ref-format" to "default-ref-storage-format"Patrick Steinhardt, Sep 7, 2026
  15. 07/11 refs: expose function to parse reference URIsPatrick Steinhardt, Sep 7, 2026
  16. Kaartic SivaraamSep 8, 2026
  17. Patrick SteinhardtSep 9, 2026
  18. 08/11 setup: refactor how we configure the ref storage formatPatrick Steinhardt, Sep 7, 2026
  19. Kaartic SivaraamSep 9, 2026
  20. Patrick SteinhardtSep 9, 2026
  21. 09/11 setup: rename ref storage format environment variablesPatrick Steinhardt, Sep 7, 2026
  22. Kaartic SivaraamSep 9, 2026
  23. Patrick SteinhardtSep 9, 2026
  24. 10/11 setup: rename "init.defaultRefFormat" to "init.defaultRefStorageFormat"Patrick Steinhardt, Sep 7, 2026
  25. 11/11 setup: allow "git init --ref-storage-format=" to specify a payloadPatrick Steinhardt, Sep 7, 2026
  26. Kaartic SivaraamSep 9, 2026
  27. Patrick SteinhardtSep 9, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.