From: "Kyle E. Mitchell" <kyle@kemitchell.com>
To: git@vger.kernel.org
Cc: "Kyle E. Mitchell" <kyle@kemitchell.com>,
Ian Wienand <iwienand@redhat.com>,
Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] doc: fix formatting of function-wrap shell alias
Date: Mon, 1 Sep 2025 11:04:18 -0700 [thread overview]
Message-ID: <20250901180419.2212086-1-kyle@kemitchell.com> (raw)
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
next reply other threads:[~2025-09-01 18:04 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-01 18:04 Kyle E. Mitchell [this message]
2025-09-01 19:17 ` [PATCH] doc: fix formatting of function-wrap shell alias Jean-Noël AVILA
2025-09-02 16:24 ` Junio C Hamano
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=20250901180419.2212086-1-kyle@kemitchell.com \
--to=kyle@kemitchell.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=iwienand@redhat.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).