]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: git-config: escape erroneous highlight markup
authorTuomas Ahola <taahol@utu.fi>
Thu, 11 Jun 2026 16:19:46 +0000 (19:19 +0300)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Jun 2026 19:08:17 +0000 (12:08 -0700)
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>
Documentation/git-config.adoc

index 8439ce97df95f26fcde9f61a332807ca9022adf4..57af010ade5b5b6b75c8eba2fa728a352773f929 100644 (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).