Git development
 help / color / mirror / Atom feed
From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
To: "Jeff King" <peff@peff.net>, git@vger.kernel.org
Subject: Re: [PATCH] gitglossary: fix indentation of sub-lists
Date: Sat, 11 Apr 2026 22:34:27 +0200	[thread overview]
Message-ID: <fb4dff1b-d304-4f29-a96c-373b1a73989b@app.fastmail.com> (raw)
In-Reply-To: <20260411190625.GA754966@coredump.intra.peff.net>

On Sat, Apr 11, 2026, at 21:06, Jeff King wrote:
> The glossary entry is a list of terms and their definitions, so
> multi-paragraph definitions need "+" continuation lines to indicate
> that they are part of a single entry.
>
> When an entry contains a sub-list (say, a bulleted list), the final "+"
> may become ambiguous: is it connecting the next paragraph to the final
> entry of the sub-list, or to the original list of definition paragraphs?
>
> Asciidoc generally connects it to the former, even when we mean the
> latter, and you end up with the next paragraph indented incorrectly,
> like this:
>
>   glob
>     ...defines glob...
>
>     Two consecutive asterisks ("**") in patterns matched
>     against full pathname may have special meaning:
>
>     - ...some special meaning of **...
>
>     - ...another special meaning of **...
>
>     - Other consecutive asterisks are considered invalid.
>
>       Glob magic is incompatible with literal magic.
>
> That final "Glob magic is incompatible" paragraph is in the wrong spot.
> It should be at the same level as "Two consecutive asterisks", as it is
> not part of the final "Other consecutive asterisks" bullet point.

`Documentation/doc-diff` confirms that this is the effect of this change.

>
> The same problem appears in several other spots in the glossary.

And that it is the effect for all the other spots at as well: pull a
paragraph out of a bullet list back to the previous block (or level).

> We can fix this by using "--" markers, which put the sub-list into its
> own block. This should catch all of the unordered lists in the glossary,
> which I found by grepping for " -" list markers.

Yes, for what it’s worth I think open blocks (`--`) are a great cure for
this when you are lucky enough to not already be in an open block.

AsciiDoc is certainly a format.

>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> Just happened to notice this while looking at the "ref" entry.
>
>  Documentation/glossary-content.adoc | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
>[snip]

  reply	other threads:[~2026-04-11 20:34 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-11 19:06 [PATCH] gitglossary: fix indentation of sub-lists Jeff King
2026-04-11 20:34 ` Kristoffer Haugsbakk [this message]
2026-04-11 20:47   ` Kristoffer Haugsbakk
2026-04-11 21:42     ` Jeff King
2026-04-11 21:55       ` [PATCH v2] " Jeff King
2026-04-12  9:10         ` Kristoffer Haugsbakk
2026-04-12 19:56           ` Jeff King

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=fb4dff1b-d304-4f29-a96c-373b1a73989b@app.fastmail.com \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox