git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Matthew Hughes <matthewhughes934@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] docs: fix typesetting of merge driver placeholders
Date: Tue, 07 Jan 2025 15:11:01 -0800	[thread overview]
Message-ID: <xmqqed1eqkxm.fsf@gitster.g> (raw)
In-Reply-To: <20250107212421.7yyvuzw4uqxnqv7t@archP14s> (Matthew Hughes's message of "Tue, 7 Jan 2025 21:24:21 +0000")

Matthew Hughes <matthewhughes934@gmail.com> writes:

> Following the `CodingGuidlines`, since these placeholders are literal
> they should be typeset verbatim, so fix some that aren't.
>
> Signed-off-by: Matthew Hughes <matthewhughes934@gmail.com>
> ---
>  Documentation/gitattributes.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Yup, especially the %P placeholder uses the backquote/literal
mark-up already in a few lines above, this is an obviously right
thing to do.

Will queue.  Thanks.

>
> diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
> index e6150595af..5d12b78549 100644
> --- a/Documentation/gitattributes.txt
> +++ b/Documentation/gitattributes.txt
> @@ -1166,7 +1166,7 @@ internal merge and the final merge.
>  The merge driver can learn the pathname in which the merged result
>  will be stored via placeholder `%P`. The conflict labels to be used
>  for the common ancestor, local head and other head can be passed by
> -using '%S', '%X' and '%Y` respectively.
> +using `%S`, `%X` and `%Y` respectively.
>  
>  `conflict-marker-size`
>  ^^^^^^^^^^^^^^^^^^^^^^
>
> base-commit: 14650065b76b28d3cfa9453356ac5669b19e706e

      reply	other threads:[~2025-01-07 23:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-07 21:24 [PATCH] docs: fix typesetting of merge driver placeholders Matthew Hughes
2025-01-07 23:11 ` Junio C Hamano [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=xmqqed1eqkxm.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=matthewhughes934@gmail.com \
    /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;
as well as URLs for NNTP newsgroup(s).