threads / patch / 64066

patchdoc: fix formatting of function-wrap shell alias

Subject: [PATCH] doc: fix formatting of function-wrap shell alias

## tl;dr

3 messages between Sep 1, 2025 and Sep 2, 2025. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Kyle E. Mitchell· Sep 1, 2025, 18:04 UTC · lore

Add a missed backtick to the end of a code segment so that it will be rendered like preceding examples.

I deeply appreciate the thoroughness of this documentation. I noticed the formatting discrepancy reading https://git-scm.com/docs/git-config.

Signed-off-by: Kyle E. Mitchell <kyle@kemitchell.com>
---
 Documentation/config/alias.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/config/alias.adoc +1 −1
diff --git a/Documentation/config/alias.adoc b/Documentation/config/alias.adoc
index 2c5db0ad84..95825354bf 100644
--- a/Documentation/config/alias.adoc
+++ b/Documentation/config/alias.adoc
@@ -38,6 +38,6 @@ it will be treated as a shell command.  For example, defining
 ** A convenient way to deal with this is to write your script
    operations in an inline function that is then called with any
    arguments from the command-line.  For example `alias.cmd = "!c() {
-   echo $1 | grep $2 ; }; c" will correctly execute the prior example.
+   echo $1 | grep $2 ; }; c"` will correctly execute the prior example.
 ** Setting `GIT_TRACE=1` can help you debug the command being run for
    your alias.
-- 
2.51.0
Jean-Noël AVILA· Sep 1, 2025, 19:17 UTC · re: Kyle E. Mitchell · lore

Re: [PATCH] doc: fix formatting of function-wrap shell alias

On Monday, 1 September 2025 20:04:18 CEST Kyle E. Mitchell wrote:
Show 12 quoted lines
> Add a missed backtick to the end of a code segment so that it will be
> rendered like preceding examples.
> 
> I deeply appreciate the thoroughness of this documentation.  I noticed
> the formatting discrepancy reading https://git-scm.com/docs/git-config.
> 
> Signed-off-by: Kyle E. Mitchell <kyle@kemitchell.com>
> ---
>  Documentation/config/alias.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/config/alias.adoc b/Documentation/config/
alias.adoc
> index 2c5db0ad84..95825354bf 100644
> --- a/Documentation/config/alias.adoc
> +++ b/Documentation/config/alias.adoc
> @@ -38,6 +38,6 @@ it will be treated as a shell command.  For example, 
defining
Show 7 quoted lines
>  ** A convenient way to deal with this is to write your script
>     operations in an inline function that is then called with any
>     arguments from the command-line.  For example `alias.cmd = "!c() {
> -   echo $1 | grep $2 ; }; c" will correctly execute the prior example.
> +   echo $1 | grep $2 ; }; c"` will correctly execute the prior example.
>  ** Setting `GIT_TRACE=1` can help you debug the command being run for
>     your alias.
Obviously correct.
Thanks!
Junio C Hamano· Sep 2, 2025, 16:24 UTC · re: Jean-Noël AVILA · lore

Re: [PATCH] doc: fix formatting of function-wrap shell alias

Jean-Noël AVILA <jn.avila@free.fr> writes:
Show 28 quoted lines
> On Monday, 1 September 2025 20:04:18 CEST Kyle E. Mitchell wrote:
>> Add a missed backtick to the end of a code segment so that it will be
>> rendered like preceding examples.
>> 
>> I deeply appreciate the thoroughness of this documentation.  I noticed
>> the formatting discrepancy reading https://git-scm.com/docs/git-config.
>> 
>> Signed-off-by: Kyle E. Mitchell <kyle@kemitchell.com>
>> ---
>>  Documentation/config/alias.adoc | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/config/alias.adoc b/Documentation/config/
> alias.adoc
>> index 2c5db0ad84..95825354bf 100644
>> --- a/Documentation/config/alias.adoc
>> +++ b/Documentation/config/alias.adoc
>> @@ -38,6 +38,6 @@ it will be treated as a shell command.  For example, 
> defining
>>  ** A convenient way to deal with this is to write your script
>>     operations in an inline function that is then called with any
>>     arguments from the command-line.  For example `alias.cmd = "!c() {
>> -   echo $1 | grep $2 ; }; c" will correctly execute the prior example.
>> +   echo $1 | grep $2 ; }; c"` will correctly execute the prior example.
>>  ** Setting `GIT_TRACE=1` can help you debug the command being run for
>>     your alias.
>
> Obviously correct.
Thanks, both of you.

← back to recent threads