All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Julia Evans <julia@jvns.ca>
Cc: "D. Ben Knoble" <ben.knoble@gmail.com>,
	 Julia Evans via GitGitGadget <gitgitgadget@gmail.com>,
	 git@vger.kernel.org,
	 Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Subject: Re: [PATCH v4] doc: checkout: rewrite detached HEAD state explanation
Date: Fri, 13 Nov 2026 18:54:49 -0800	[thread overview]
Message-ID: <xmqq4idk86me.fsf@gitster.g> (raw)
In-Reply-To: <xmqqpkw89yzi.fsf@gitster.g> (Junio C. Hamano's message of "Fri, 13 Nov 2026 13:56:49 -0800")

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.


  parent reply	other threads:[~2026-11-14  2:54 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-07 14:52 [PATCH] doc: checkout: rewrite detached HEAD state explanation Julia Evans via GitGitGadget
2026-10-07 16:43 ` Junio C Hamano
2026-10-13 12:54   ` Julia Evans
2026-10-19 14:05   ` Julia Evans
2026-10-19 21:24     ` Junio C Hamano
2026-10-20 12:52       ` Julia Evans
2026-10-20 13:06         ` Julia Evans
2026-10-07 19:02 ` Kristoffer Haugsbakk
2026-10-13 11:48   ` Julia Evans
2026-10-13 12:20     ` Kristoffer Haugsbakk
2026-10-13 12:27       ` Julia Evans
2026-10-13 12:42         ` Julia Evans
2026-10-13 13:01 ` [PATCH v2] " Julia Evans via GitGitGadget
2026-10-14 18:52   ` Junio C Hamano
2026-10-14 21:10     ` Julia Evans
2026-10-15 20:58 ` [PATCH v3] " Julia Evans via GitGitGadget
2026-10-15 22:39   ` Junio C Hamano
2026-10-16 14:55     ` Julia Evans
2026-10-16 17:03       ` Junio C Hamano
2026-10-16 18:35         ` Julia Evans
2026-10-16 19:05           ` Junio C Hamano
2026-10-16 19:03 ` [PATCH v4] " Julia Evans via GitGitGadget
2026-10-16 21:10   ` Junio C Hamano
2026-11-07 20:06     ` D. Ben Knoble
2026-11-08  4:25       ` Junio C Hamano
2026-11-09 21:48         ` Julia Evans
2026-11-10  6:46           ` Junio C Hamano
2026-11-10 13:13             ` Julia Evans
2026-11-11 21:45       ` Julia Evans
2026-11-12  1:58         ` Ben Knoble
2026-11-12 15:40         ` Junio C Hamano
2026-11-12 16:37           ` Julia Evans
2026-11-12 19:25             ` Junio C Hamano
2026-11-12 22:45               ` Julia Evans
2026-11-13  2:25                 ` Junio C Hamano
2026-11-13 12:45                   ` Julia Evans
2026-11-13 17:23                     ` Junio C Hamano
2026-11-13 17:57                       ` Julia Evans
2026-11-13 18:43                         ` Julia Evans
2026-11-14  1:54                         ` Junio C Hamano
2026-11-14  2:28                           ` Julia Evans
2026-11-13 19:49                       ` Julia Evans
2026-11-13 21:56                         ` Junio C Hamano
2026-11-13 22:17                           ` Julia Evans
2026-11-14  2:54                           ` Junio C Hamano [this message]
2026-10-16 22:02   ` Junio C Hamano
2026-11-11 21:34 ` [PATCH v5] " Julia Evans via GitGitGadget
2026-11-11 23:14   ` Junio C Hamano
2026-11-12  0:01     ` Julia Evans
2026-11-12  4:08     ` Junio C Hamano
2026-11-12 22:47 ` [PATCH v6] " Julia Evans via GitGitGadget

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq4idk86me.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=julia@jvns.ca \
    --cc=kristofferhaugsbakk@fastmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.