Re: [PATCH v4] doc: checkout: rewrite detached HEAD state explanation
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Nov 14, 2026, 02:54 UTC
- Message-ID
- <xmqq4idk86me.fsf@gitster.g>
- In-Reply-To
- <xmqqpkw89yzi.fsf@gitster.g>
Junio C Hamano <gitster@pobox.com> writes:
> This is a manual page, which means it has to cater to both audiences. > Unlike a tutorial or guide, we cannot say we target this audience > primarily and expect the other audience to figure things out > themselves.
The detached-head.adoc is still a part of a manual page for the checkout command, but gitdetached-head.adoc can have its own material. It does not need to stay "just include detached-head.adoc and be done with it" documentation at all.
> Perhaps a FAQ or "survival guide" that targets these inexperienced > users would help? Unlike manual pages, guides have more freedom in > choosing the material covered and the order in which they are > presented. I dunno.
So the rest of the gitdetached-head.adoc, other than the "include detached-head.adoc" line, can be the "survival guide" document, if we wanted it to.