doc: git-config: escape erroneous highlight markup

Paired octothorpes are used in AsciiDoc to mark highlighted text,
<mark> being the equivalent HTML tag.  To use the symbol as a literal
character, it can be escaped with backticks.

Do so in git-config.adoc.

While at it, tweak the text slightly to make it scan better.

Signed-off-by: Tuomas Ahola <taahol@utu.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Tuomas Ahola
2026-06-11 19:19:46 +03:00
committed by Junio C Hamano
parent 042221cccb
commit 4fa2c6e045

View File

@@ -119,10 +119,10 @@ OPTIONS
Append a comment at the end of new or modified lines.
+
If _<message>_ begins with one or more whitespaces followed
by "#", it is used as-is. If it begins with "#", a space is
prepended before it is used. Otherwise, a string " # " (a
by `#`, it is used as-is. If it begins with `#`, a space is
prepended before it is used. Otherwise, a string `" # "` (a
space followed by a hash followed by a space) is prepended
to it. And the resulting string is placed immediately after
to it. The resulting string is placed immediately after
the value defined for the variable. The _<message>_ must
not contain linefeed characters (no multi-line comments are
permitted).