git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] doc: fix formatting of function-wrap shell alias
@ 2025-09-01 18:04 Kyle E. Mitchell
  2025-09-01 19:17 ` Jean-Noël AVILA
  0 siblings, 1 reply; 3+ messages in thread
From: Kyle E. Mitchell @ 2025-09-01 18:04 UTC (permalink / raw)
  To: git; +Cc: Kyle E. Mitchell, Ian Wienand, Junio C Hamano

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


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: fix formatting of function-wrap shell alias
  2025-09-01 18:04 [PATCH] doc: fix formatting of function-wrap shell alias Kyle E. Mitchell
@ 2025-09-01 19:17 ` Jean-Noël AVILA
  2025-09-02 16:24   ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Jean-Noël AVILA @ 2025-09-01 19:17 UTC (permalink / raw)
  To: git, Kyle E. Mitchell; +Cc: Kyle E. Mitchell, Ian Wienand, Junio C Hamano

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!




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: fix formatting of function-wrap shell alias
  2025-09-01 19:17 ` Jean-Noël AVILA
@ 2025-09-02 16:24   ` Junio C Hamano
  0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2025-09-02 16:24 UTC (permalink / raw)
  To: Jean-Noël AVILA; +Cc: git, Kyle E. Mitchell, Ian Wienand

Jean-Noël AVILA <jn.avila@free.fr> writes:

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-09-02 16:24 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-01 18:04 [PATCH] doc: fix formatting of function-wrap shell alias Kyle E. Mitchell
2025-09-01 19:17 ` Jean-Noël AVILA
2025-09-02 16:24   ` Junio C Hamano

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