Git development
 help / color / mirror / Atom feed
From: Tuomas Ahola <taahol@utu.fi>
To: <git@vger.kernel.org>
Cc: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>,
	"Junio C Hamano" <gitster@pobox.com>, "Jeff King" <peff@peff.net>,
	"Jean-Noël Avila" <jn.avila@free.fr>,
	"Tuomas Ahola" <taahol@utu.fi>
Subject: [PATCH v3 3/3] doc: git-config: escape erroneous highlight markup
Date: Thu, 11 Jun 2026 19:19:46 +0300	[thread overview]
Message-ID: <20260611161946.12166-4-taahol@utu.fi> (raw)
In-Reply-To: <20260611161946.12166-1-taahol@utu.fi>

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>
---

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 <message>
                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
    +           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 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
                <message> 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 _<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).
-- 
2.30.2


      parent reply	other threads:[~2026-06-11 16:20 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-10 18:51 [PATCH 0/3] doc: config: fix AsciiDoc glitches Tuomas Ahola
2026-06-10 18:51 ` [PATCH 1/3] doc: config: terminate runaway lists Tuomas Ahola
2026-06-10 18:51 ` [PATCH 2/3] doc: config/sideband: fix typo in adoc markup Tuomas Ahola
2026-06-10 20:13   ` Kristoffer Haugsbakk
2026-06-10 18:51 ` [PATCH 3/3] doc: git-config: escape erroneous " Tuomas Ahola
2026-06-10 19:50   ` Junio C Hamano
2026-06-10 20:07     ` Junio C Hamano
2026-06-10 22:55 ` [PATCH v2 0/3] doc: config: fix AsciiDoc glitches Tuomas Ahola
2026-06-10 22:55   ` [PATCH v2 1/3] doc: config: terminate runaway lists Tuomas Ahola
2026-06-11  6:02     ` Jeff King
2026-06-10 22:55   ` [PATCH v2 2/3] doc: config/sideband: fix description list delimiter Tuomas Ahola
2026-06-10 22:55   ` [PATCH v2 3/3] doc: git-config: escape erroneous highlight markup Tuomas Ahola
2026-06-11  6:11     ` Jeff King
2026-06-11  6:24       ` Jeff King
2026-06-11  6:25         ` Jeff King
2026-06-11  8:02       ` Tuomas Ahola
2026-06-11  8:31         ` Jeff King
2026-06-11 13:28           ` Tuomas Ahola
2026-06-11 17:33           ` Junio C Hamano
2026-06-11 16:19 ` [PATCH v3 0/3] doc: config: fix AsciiDoc glitches Tuomas Ahola
2026-06-11 16:19   ` [PATCH v3 1/3] doc: config: terminate runaway lists Tuomas Ahola
2026-06-11 16:19   ` [PATCH v3 2/3] doc: config/sideband: fix description list delimiter Tuomas Ahola
2026-06-11 16:19   ` Tuomas Ahola [this message]

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=20260611161946.12166-4-taahol@utu.fi \
    --to=taahol@utu.fi \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    --cc=kristofferhaugsbakk@fastmail.com \
    --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