Re: [PATCH v2 3/3] doc: git-config: escape erroneous highlight markup

From: Jeff King <peff@peff.net>
Date: Jun 11, 2026, 06:24 UTC
Message-ID: <20260611062423.GA2189088@coredump.intra.peff.net>
In-Reply-To: <20260611061156.GC2187173@coredump.intra.peff.net>

On Thu, Jun 11, 2026 at 02:11:57AM -0400, Jeff King wrote:

> Though curiously the case of `#` in git-fast-import seems not to get
> marked as <code> in the html output (even though the nearby `LF` does).
> I wonder if there is some special treatment of `#` or something.

Ah, weird, it has to do with our config file.

If I do this (not in the git repository):

  echo 'This is a literal `#` symbol.' >foo.adoc
  asciidoc foo.adoc
  grep -i symbol foo.html

then I get <code> markers, like:

  <div class="paragraph"><p>This is a literal <code>#</code> symbol.</p></div>

But if I build with:

  asciidoc -f path/to/git/Documentation/asciidoc.conf foo.adoc

then the grep shows:

  <div class="paragraph"><p>This is a literal # symbol.</p></div>

Looks like it is due to our [literal-inlinemacro] definition, which comes from 974cdca345 (doc: introduce a synopsis typesetting, 2024-09-24). I think this might have been an unintended side effect. +cc the author of that commit.

For the purposes of your series, I think we can ignore any issues with [literal-inlinemacro] for the moment, and decide on "\" versus `` depending on which we prefer.

-Peff