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

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

From
Julia Evans <julia@jvns.ca>
Date
Oct 13, 2026, 12:42 UTC
Message-ID
<5e07d489-ca34-4dcb-8953-c58d30261926@app.fastmail.com>
In-Reply-To
<1637a8fb-d689-47fe-a008-e8e90d9889b9@app.fastmail.com>
Show 13 quoted lines
>> 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`.

Reflecting on this a little more, I think there's a bit of a disconnect between how we recommend users use the Git help system (via `git help config`) and how we refer to other man pages in the man pages, which is like this:

> (see git-fetch(1), git-config(1) and gitmodules(5))

If a user sees a reference like `git-config(1)` or `gitmodules(5)`, the most obvious way to look it up is to type `man git-config`, or `man gitmodules` and not to deduce that you can run `git help config` or `git help modules`: Especially because sometimes you need to remove a `git-` from the beginning and sometimes just `git`. I'm don't think the `git-help` man page even explains how those prefixes work.

So at some point if we want to really encourage people to use `git help` instead of `man` we might want to revisit how we present the internal references in the man pages.

Obviously not something to solve right now, and I don't know what a good solution would be.

Previous: Julia EvansNext: Julia Evans via GitGitGadget
Message 12 of 53 in “doc: checkout: rewrite detached HEAD state explanation”
  1. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Oct 7, 2026
  2. Junio C HamanoOct 7, 2026
  3. Julia EvansOct 13, 2026
  4. Julia EvansOct 19, 2026
  5. Junio C HamanoOct 19, 2026
  6. Julia EvansOct 20, 2026
  7. Julia EvansOct 20, 2026
  8. Kristoffer HaugsbakkOct 7, 2026
  9. Julia EvansOct 13, 2026
  10. Kristoffer HaugsbakkOct 13, 2026
  11. Julia EvansOct 13, 2026
  12. Julia EvansOct 13, 2026
  13. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Oct 13, 2026
  14. Junio C HamanoOct 14, 2026
  15. Julia EvansOct 14, 2026
  16. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Oct 15, 2026
  17. Junio C HamanoOct 15, 2026
  18. Julia EvansOct 16, 2026
  19. Junio C HamanoOct 16, 2026
  20. Julia EvansOct 16, 2026
  21. Junio C HamanoOct 16, 2026
  22. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Oct 16, 2026
  23. Junio C HamanoOct 16, 2026
  24. D. Ben KnobleNov 7, 2026
  25. Junio C HamanoNov 8, 2026
  26. Julia EvansNov 9, 2026
  27. Junio C HamanoNov 10, 2026
  28. Julia EvansNov 10, 2026
  29. Julia EvansNov 11, 2026
  30. Ben KnobleNov 12, 2026
  31. Junio C HamanoNov 12, 2026
  32. Julia EvansNov 12, 2026
  33. Junio C HamanoNov 12, 2026
  34. Julia EvansNov 12, 2026
  35. Junio C HamanoNov 13, 2026
  36. Julia EvansNov 13, 2026
  37. Junio C HamanoNov 13, 2026
  38. Julia EvansNov 13, 2026
  39. Julia EvansNov 13, 2026
  40. Junio C HamanoNov 14, 2026
  41. Julia EvansNov 14, 2026
  42. Julia EvansNov 13, 2026
  43. Junio C HamanoNov 13, 2026
  44. Julia EvansNov 13, 2026
  45. Junio C HamanoNov 14, 2026
  46. Junio C HamanoOct 16, 2026
  47. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Nov 11, 2026
  48. Junio C HamanoNov 11, 2026
  49. Julia EvansNov 12, 2026
  50. Junio C HamanoNov 12, 2026
  51. doc: checkout: rewrite detached HEAD state explanationJulia Evans via GitGitGadget, Nov 12, 2026
  52. doc: add new detached HEAD state guideJulia Evans via GitGitGadget, Nov 16, 2026
  53. Junio C HamanoNov 16, 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.