Skip to content

Commit 174443e

Browse files
ianwgitster
authored andcommitted
Documentation: alias: rework notes into points
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 786a3e4 commit 174443e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Documentation/config/alias.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ If the alias expansion is prefixed with an exclamation point,
2121
it will be treated as a shell command. For example, defining
2222
`alias.new = !gitk --all --not ORIG_HEAD`, the invocation
2323
`git new` is equivalent to running the shell command
24-
`gitk --all --not ORIG_HEAD`. Note that shell commands will be
25-
executed from the top-level directory of a repository, which may
26-
not necessarily be the current directory.
27-
`GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
28-
from the original current directory. See linkgit:git-rev-parse[1].
24+
`gitk --all --not ORIG_HEAD`. Note:
25+
+
26+
* Shell commands will be executed from the top-level directory of a
27+
repository, which may not necessarily be the current directory.
28+
* `GIT_PREFIX` is set as returned by running `git rev-parse --show-prefix`
29+
from the original current directory. See linkgit:git-rev-parse[1].

0 commit comments

Comments
 (0)