[PATCH] docs: fix typesetting of merge driver placeholders

Matthew Hughes· Jan 7, 2025, 21:24 UTC · lore

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

Show changes to Documentation/gitattributes.txt +1 −1

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

-- 
2.47.1

Junio C Hamano· Jan 7, 2025, 23:11 UTC · re: Matthew Hughes · lore

Re: [PATCH] docs: fix typesetting of merge driver placeholders

Matthew Hughes <matthewhughes934@gmail.com> writes:

Show 7 quoted lines

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

Show 16 quoted lines

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

patchdocs: fix typesetting of merge driver placeholders