Skip to content

Commit 459842e

Browse files
Denton-Lgitster
authored andcommitted
config/alias.txt: document alias accepting non-command first word
One can see that an alias that begins with a non-command first word, such as `loud-rebase = -c commit.verbose=true rebase`, is permitted. However, this isn't immediately obvious to users as alias instances typically begin with a command. Document the fact that an alias can begin with a non-command first word so that users will be able to discover that this is a feature. Signed-off-by: Denton Liu <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 01991ce commit 459842e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Documentation/config/alias.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ alias.*::
77
spaces, the usual shell quoting and escaping is supported.
88
A quote pair or a backslash can be used to quote them.
99
+
10+
Note that the first word of an alias does not necessarily have to be a
11+
command. It can be a command-line option that will be passed into the
12+
invocation of `git`. In particular, this is useful when used with `-c`
13+
to pass in one-time configurations or `-p` to force pagination. For example,
14+
`loud-rebase = -c commit.verbose=true rebase` can be defined such that
15+
running `git loud-rebase` would be equivalent to
16+
`git -c commit.verbose=true rebase`. Also, `ps = -p status` would be a
17+
helpful alias since `git ps` would paginate the output of `git status`
18+
where the original command does not.
19+
+
1020
If the alias expansion is prefixed with an exclamation point,
1121
it will be treated as a shell command. For example, defining
1222
`alias.new = !gitk --all --not ORIG_HEAD`, the invocation

0 commit comments

Comments
 (0)