Re: [PATCH] doc: checkout: rewrite detached HEAD state explanation

["Julia Evans" <julia@jvns.ca>]

On Tue, Oct 13, 2026, at 8:20 AM, Kristoffer Haugsbakk wrote:
> On Tue, Oct 13, 2026, at 13:48, Julia Evans wrote:
>> On Wed, Oct 7, 2026, at 3:02 PM, Kristoffer Haugsbakk wrote:
>>>>[snip]
>>>>  Documentation/detached-head.adoc   |  43 ++++++++++
>>>>  Documentation/git-checkout.adoc    | 129 +----------------------------
>>>>  Documentation/gitdetachedhead.adoc |  14 ++++
>>>
>>> Why in one word instead of hyphenating `detached-head`?
>>> (gitdetached-head(7))
>>
>> Currently the guides are all one word with no hyphens.
>> Happy to use a different style if folks think we shouldn't use
>> the current naming convention for the guides
>
> I’m confused. It doesn’t look like that to me?
>
>     $ git help --guides
>     The Git concept guides are:
>        core-tutorial    A Git core tutorial for developers
>        credentials      Providing usernames and passwords to Git
>        cvs-migration    Git for CVS users
>        diffcore         Tweaking diff output
>        everyday         A useful minimum set of commands for Everyday Git
>        faq              Frequently asked questions about using Git
>        glossary         A Git Glossary
>        namespaces       Git namespaces
>        remote-helpers   Helper programs to interact with remote repositories
>        submodules       Mounting one repository inside another
>        tutorial         A tutorial introduction to Git
>        tutorial-2       A tutorial introduction to Git: part two
>        workflows        An overview of recommended workflows with Git
>
>     'git help -a' and 'git help -g' list available subcommands and some
>     concept guides. See 'git help <command>' or 'git help <concept>'
>     to read about a specific subcommand or concept.
>     See 'git help git' for an overview of the system.
>
> What is definitely the case is that there is no hyphen between `git` and
> the first word, maybe in order to distinguish section 1 commands) and
> section 5 and 7 manpages.

Thanks, I'll change the naming, I didn't realize that. For some reason I felt
sure it was the other way. Maybe we should rename `gitmergeconflicts`
to `gitmerge-conflicts` in the other patch series too.

My best guess is that I made that mistake because I (maybe idiosyncratically)
always use `man <page>`  to access the Git man pages, and typing
`man gitdetached-head` feels awkward to me. 
But of course we're recommending that folks use `git help detached-head`,
and `git help detached-head` is much nicer than `git help detachedhead`.