From: Ian Wienand <iwienand@redhat.com>
To: git@vger.kernel.org
Cc: Ian Wienand <iwienand@redhat.com>
Subject: [PATCH v6 1/3] Documentation: alias: rework notes into points
Date: Sun, 26 May 2024 09:44:33 +1000 [thread overview]
Message-ID: <20240525234454.1489598-1-iwienand@redhat.com> (raw)
In-Reply-To: <20240525012207.1415196-1-iwienand@redhat.com>
There are a number of caveats when using aliases. Rather than
stuffing them all together in a paragraph, let's separate them out
into individual points to make it clearer what's going on.
Signed-off-by: Ian Wienand <iwienand@redhat.com>
---
Documentation/config/alias.txt | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.txt
index 01df96fab3..40851ef429 100644
--- a/Documentation/config/alias.txt
+++ b/Documentation/config/alias.txt
@@ -21,8 +21,9 @@ If the alias expansion is prefixed with an exclamation point,
it will be treated as a shell command. For example, defining
`alias.new = !gitk --all --not ORIG_HEAD`, the invocation
`git new` is equivalent to running the shell command
-`gitk --all --not ORIG_HEAD`. Note that shell commands will be
-executed from the top-level directory of a repository, which may
-not necessarily be the current directory.
-`GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
-from the original current directory. See linkgit:git-rev-parse[1].
+`gitk --all --not ORIG_HEAD`. Note:
++
+* Shell commands will be executed from the top-level directory of a
+ repository, which may not necessarily be the current directory.
+* `GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
+ from the original current directory. See linkgit:git-rev-parse[1].
--
2.45.1
next prev parent reply other threads:[~2024-05-25 23:45 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-22 2:41 [PATCH] alias: document caveats and add trace of prepared command Ian Wienand
2024-05-22 3:29 ` Eric Sunshine
2024-05-22 16:07 ` Junio C Hamano
2024-05-23 0:38 ` Ian Wienand
2024-05-23 4:20 ` [PATCH v2 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-23 4:20 ` [PATCH v2 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-23 4:20 ` [PATCH v2 3/3] run-command: show prepared command Ian Wienand
2024-05-23 4:27 ` [PATCH v2 1/3] Documentation: alias: rework notes into points Eric Sunshine
2024-05-23 4:39 ` Ian Wienand
2024-05-23 4:37 ` [PATCH v3 " Ian Wienand
2024-05-23 4:37 ` [PATCH v3 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-23 4:37 ` [PATCH v3 3/3] run-command: show prepared command Ian Wienand
2024-05-23 15:29 ` Junio C Hamano
2024-05-23 23:40 ` Junio C Hamano
2024-05-24 6:09 ` Junio C Hamano
2024-05-24 7:18 ` Ian Wienand
2024-05-24 15:33 ` Junio C Hamano
2024-05-24 0:43 ` Ian Wienand
2024-05-24 17:50 ` Junio C Hamano
2024-05-25 1:13 ` Ian Wienand
2024-05-23 15:14 ` [PATCH v3 1/3] Documentation: alias: rework notes into points Junio C Hamano
2024-05-24 7:32 ` [PATCH v4 " Ian Wienand
2024-05-24 7:32 ` [PATCH v4 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-24 7:32 ` [PATCH v4 3/3] run-command: show prepared command Ian Wienand
2024-05-24 19:16 ` Junio C Hamano
2024-05-24 19:58 ` Junio C Hamano
2024-05-25 1:14 ` Ian Wienand
2024-05-25 1:20 ` [PATCH v5 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-25 1:20 ` [PATCH v5 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-25 1:20 ` [PATCH v5 3/3] run-command: show prepared command Ian Wienand
2024-05-25 5:44 ` Junio C Hamano
2024-05-25 6:06 ` Junio C Hamano
2024-05-25 23:49 ` Ian Wienand
2024-05-25 23:44 ` Ian Wienand [this message]
2024-05-25 23:44 ` [PATCH v6 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-26 23:26 ` Junio C Hamano
2024-05-27 0:22 ` Ian Wienand
2024-05-25 23:44 ` [PATCH v6 3/3] run-command: show prepared command Ian Wienand
2024-05-26 16:20 ` Junio C Hamano
2024-05-27 0:30 ` [PATCH v7 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-27 0:30 ` [PATCH v7 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-27 17:48 ` Junio C Hamano
2024-05-27 0:30 ` [PATCH v7 3/3] run-command: show prepared command Ian Wienand
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=20240525234454.1489598-1-iwienand@redhat.com \
--to=iwienand@redhat.com \
--cc=git@vger.kernel.org \
/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).