From: Tuomas Ahola Date: Thu, 11 Jun 2026 16:19:46 GMT Subject: [PATCH v3 3/3] doc: git-config: escape erroneous highlight markup Message-ID: <20260611161946.12166-4-taahol@utu.fi> In-Reply-To: <20260611161946.12166-1-taahol@utu.fi> Paired octothorpes are used in AsciiDoc to mark highlighted text, 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 --- Notes (doc-diff): diff --git a/ca65211ea4c351071c5e76dabe4700ad074b75d3/home/taahol/share/man/man1/git-config.1 b/e2d0cc8218242cc859daabb179af07ebf96fe459/home/taahol/share/man/man1/git-config.1 index e0e2bf3c36..1e9e49b197 100644 --- a/ca65211ea4c351071c5e76dabe4700ad074b75d3/home/taahol/share/man/man1/git-config.1 +++ b/e2d0cc8218242cc859daabb179af07ebf96fe459/home/taahol/share/man/man1/git-config.1 @@ -113,11 +113,11 @@ OPTIONS --comment Append a comment at the end of new or modified lines. - If begins with one or more whitespaces followed by "", it - is used as-is. If it begins with "", a space is prepended before it + If 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 space followed by a hash - followed by a space) is prepended to it. And the resulting string - is placed immediately after the value defined for the variable. The + followed by a space) is prepended to it. The resulting string is + placed immediately after the value defined for the variable. The must not contain linefeed characters (no multi-line comments are permitted). Documentation/git-config.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc index 8439ce97df..57af010ade 100644 --- a/Documentation/git-config.adoc +++ b/Documentation/git-config.adoc @@ -119,10 +119,10 @@ OPTIONS Append a comment at the end of new or modified lines. + If __ 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 __ must not contain linefeed characters (no multi-line comments are permitted). -- 2.30.2