Re: [PATCH 3/3] doc: git-config: escape erroneous adoc markup
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jun 10, 2026, 19:50 UTC
- Message-ID
- <xmqqecieuqdm.fsf@gitster.g>
- In-Reply-To
- <20260610185148.23920-4-taahol@utu.fi>
Tuomas Ahola <taahol@utu.fi> writes:
Show 12 quoted lines
> 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 a backslash. > > 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> > --- > Documentation/git-config.adoc | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-)
Thanks.
What we see in https://git-scm.com/docs/git-config#Documentation/git-config.txt---commentmessage is rather embarrasing. This would be a vast improvement ;-)
Show 17 quoted lines
> diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc > index 8439ce97df..708e88cdeb 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 > +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).