All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: kristofferhaugsbakk@fastmail.com
Cc: git@vger.kernel.org,  Kristoffer Haugsbakk <code@khaugsbakk.name>,
	Siddharth Asthana <siddharthasthana31@gmail.com>
Subject: Re: [PATCH 3/4] doc: replay: use a nested definition list
Date: Sun, 31 May 2026 07:37:24 +0900	[thread overview]
Message-ID: <xmqqtsroed7f.fsf@gitster.g> (raw)
In-Reply-To: <--ref-action_definition_list.70c@msgid.xyz> (kristofferhaugsbakk@fastmail.com's message of "Thu, 21 May 2026 20:02:00 +0200")

kristofferhaugsbakk@fastmail.com writes:

> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> This bullet list for `--ref-action` introduces a term with a colon.
> This is exactly what a definition list is, structurally. Let’s be
> sylistically consistent and use the definition list markup construct.

Makes sense.

>  --
> -	* `update` (default): Update refs directly using an atomic transaction.
> -	  All refs are updated or none are (all-or-nothing behavior).
> -	* `print`: Output update-ref commands for pipeline use. This is the
> -	  traditional behavior where output can be piped to `git update-ref --stdin`.
> +`update` (default);; Update refs directly using an atomic transaction.
> +	All refs are updated or none are (all-or-nothing behavior).
> +`print`;; Output update-ref commands for pipeline use. This is the
> +	traditional behavior where output can be piped to `git update-ref --stdin`.
>  --
>  +

The transition from a bulleted list to a nested definition list
(`;;`) for the `--ref-action` modes indeed makes the document
structure much cleaner.

>  The default mode can be configured via the `replay.refAction` configuration variable.

  reply	other threads:[~2026-05-30 22:37 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-21 18:01 [PATCH 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-05-21 18:01 ` [PATCH 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-05-30 22:18   ` Junio C Hamano
2026-06-04 20:38     ` Kristoffer Haugsbakk
2026-05-21 18:01 ` [PATCH 2/4] doc: replay: simplify replay.refAction description kristofferhaugsbakk
2026-05-30 22:29   ` Junio C Hamano
2026-05-30 22:37   ` Junio C Hamano
2026-06-02 11:58     ` Kristoffer Haugsbakk
2026-05-21 18:02 ` [PATCH 3/4] doc: replay: use a nested definition list kristofferhaugsbakk
2026-05-30 22:37   ` Junio C Hamano [this message]
2026-05-21 18:02 ` [PATCH 4/4] doc: replay: move “default” to the right-hand-side kristofferhaugsbakk
2026-05-30 22:37   ` Junio C Hamano
2026-05-30 22:18 ` [PATCH 0/4] doc: replay: fix config link Junio C Hamano
2026-06-03 16:04 ` [PATCH v2 " kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-04  6:27     ` Patrick Steinhardt
2026-06-04  6:31       ` Kristoffer Haugsbakk
2026-06-04  9:05         ` Patrick Steinhardt
2026-06-03 16:04   ` [PATCH v2 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-03 16:04   ` [PATCH v2 4/4] doc: replay: move “default” to the right-hand side kristofferhaugsbakk
2026-06-05 13:55   ` [PATCH v3 0/4] doc: replay: fix config link kristofferhaugsbakk
2026-06-05 13:55     ` [PATCH v3 1/4] doc: link to config for git-replay(1) kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 2/4] doc: replay: improve config description kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 3/4] doc: replay: use a nested description list kristofferhaugsbakk
2026-06-05 13:56     ` [PATCH v3 4/4] doc: replay: move “default” to the right-hand side kristofferhaugsbakk

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=xmqqtsroed7f.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=kristofferhaugsbakk@fastmail.com \
    --cc=siddharthasthana31@gmail.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.