]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: alias: rework notes into points
authorIan Wienand <iwienand@redhat.com>
Mon, 27 May 2024 00:30:47 +0000 (10:30 +1000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 27 May 2024 17:44:07 +0000 (10:44 -0700)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/alias.txt

index 01df96fab3df11f1c804e26ed7c312cd7490e2fd..40851ef429cbd1fb990d8b4a3976a427c5f3e9aa 100644 (file)
@@ -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].