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

Re: [PATCH] git-tag(1): Refer to git-check-ref-format(1) for <name>

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 25, 2009, 20:37 UTC
Message-ID
<7vd46jocjp.fsf@alter.siamese.dyndns.org>
In-Reply-To
<20090825172100.6117@nanako3.lavabit.com>
Nanako Shiraishi <nanako3@lavabit.com> writes:
Show 14 quoted lines
> Quoting myself...
>
>> Subject: Documentation: consistently refer to check-ref-format
>>
>> Change the <name> placeholder to <tagname> in the SYNOPSIS section of
>> git-tag documentation, and describe it in the OPTIONS section in a way
>> similar to how documentation for git-branch does.
>>
>> Add SEE ALSO section to list the other documentation pages these two pages
>> refer to.
>>
>> Signed-off-by: Nanako Shiraishi <nanako3@lavabit.com>
>
> Should I further polish this patch?

No, it just fell through the cracks of my mailbox. I tend to agree that it is better to mention only the presense of rules, and refer to the rules described in the definitive document.

Safe names are designed to be what most sane people would naturally choose to use anyway and they would not need to see the clutter that describes only the half of the rules there. And more importantly, the people who do get errors by choosing illegal names by accident would _want_ to see the full set of rules before choosing another name to avoid getting the same error again.

Spelling only the half of the rules in the tag/branch manual page would not help neither audience.

Previous: Nanako Shiraishi
Message 6 of 6 in “git-tag(1): Refer to git-check-ref-format(1) for <name>”
  1. git-tag(1): Refer to git-check-ref-format(1) for <name>Jari Aalto, Aug 3, 2009
  2. Junio C HamanoAug 4, 2009
  3. git-tag(1): Refer to git-check-ref-format(1) for <name>Jari Aalto, Aug 5, 2009
  4. Nanako ShiraishiAug 22, 2009
  5. Nanako ShiraishiAug 25, 2009
  6. Junio C HamanoAug 25, 2009

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.