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

Re: [PATCH v2 01/11] builtin/init: rename "--ref-format=" to "--ref-storage-format="

From
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Date
Sep 9, 2026, 09:14 UTC
Message-ID
<472d9d2b-efea-48a9-98f0-02364b1a9ccf@gmail.com>
In-Reply-To
<aqED9Xn6xibcp9pf@pks.im>
On 9/9/26 12:30, Patrick Steinhardt wrote:
Show 8 quoted lines
> On Tue, Sep 08, 2026 at 02:31:22PM +0530, Kaartic Sivaraam wrote:
> 
> I'm aiming for a a quiet deprecation -- the old options keep on working,
> but we don't show them anymore. We may eventually remove them
> altogether, but I neither want to warn about use of old options now or
> even remove them as that would likely cause more negative consequences
> than is worth it. It's not like we want to soon use the old names.
> 
Understood.
Show 5 quoted lines
> 
> But I agree that we should keep the old options documented. Otherwise,
> it might be hard to figure out what those options do in case they for
> example still exist in an old script.
> 
Yeah, makes sense.
Show 9 quoted lines
>>
>> Relevant only if we are deprecating the old option: We could change the
>> description of the old option to convey that it is deprecated so that it
>> could be easily distinguished by anyone reading through. I suggest this by
>> noting a similar pattern in `builtin/name-rev.c` for the `--stdin` argument.
> 
> We don't really have to update the description as we pass
> `PARSE_OPT_HIDDEN` anyway, so the option is not even shown.
>

Indeed. I was suggesting to change the description only for the sake of someone who reads the code to quickly get an idea that we have deprecated the old names. The PARSE_OPT_HIDDEN would definitely hint at it but this just a suggestion to make it more obvious :-)

That said, it's fine if we don't change the description too. It isn't a big deal.

Show 9 quoted lines
>> If we don't plan to deprecate, I suppose we could use OPT_ALIAS to clarify
>> that `ref-format` is an alias of `ref-storage-format` similar to how
>> `recursive` is marked as an alias of `recurse-submodules` in
>> `builtin/clone.c`.
> 
> I was originally planning to use `OPT_ALIAS()`, but we don't seem to
> support `PARSE_OPT_HIDDEN` there. Maybe it's better to add a small
> preparatory patch to support that though.
> 

Indeed. OPT_ALIAS does have that caveat. A patch to allow the alias to be hidden by choice would indeed be worthwhile.

-- 
Sivaraam
Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 5 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.