[PATCH v2 0/2] Doc: document alias accepting non-command first word
- From
Denton Liu <liu.denton@gmail.com>
- Date
- Jun 5, 2019, 20:10 UTC
- Message-ID
- <cover.1559755652.git.liu.denton@gmail.com>
- In-Reply-To
- <cover.1559333840.git.liu.denton@gmail.com>
Thanks for the review, Johannes. I think it's a good idea to add another alias for `-p` so included that suggestion. Also, while I was at it, I found a typo so I fixed that too.
Changes since v1:
* s/loud-merge/loud-rebase/ * Add `-p` as another example since that was Dscho's original use-case
Denton Liu (2): config/alias.txt: change " and ' to ` config/alias.txt: document alias accepting non-command first word
Documentation/config/alias.txt | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-)
Interdiff against v1:
diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.txt index f241f03ebe..f1ca739d57 100644 --- a/Documentation/config/alias.txt +++ b/Documentation/config/alias.txt @@ -10,10 +10,12 @@ alias.*:: Note that the first word of an alias does not necessarily have to be a command. It can be a command-line option that will be passed into the invocation of `git`. In particular, this is useful when used with `-c` -to pass in one-time configurations. For example, +to pass in one-time configurations or `-p` to force pagination. For example, `loud-rebase = -c commit.verbose=true rebase` can be defined such that -running `git loud-merge` would be equivalent to -`git -c commit.verbose=true rebase`. +running `git loud-rebase` would be equivalent to +`git -c commit.verbose=true rebase`. Also, `ps = -p status` would be a +helpful alias since `git ps` would paginate the output of `git status` +where the original command does not. + If the alias expansion is prefixed with an exclamation point, it will be treated as a shell command. For example, defining
-- 2.22.0.rc1.169.g49223abbf8