mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Denton Liu <>
To: Git Mailing List <>
Cc: Johannes Schindelin <>
Subject: [PATCH 2/2] config/alias.txt: document alias accepting non-command first word
Date: Fri, 31 May 2019 16:23:06 -0400	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

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 <>
 Documentation/config/alias.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.txt
index 5425449a50..f241f03ebe 100644
--- a/Documentation/config/alias.txt
+++ b/Documentation/config/alias.txt
@@ -7,6 +7,14 @@ alias.*::
 	spaces, the usual shell quoting and escaping is supported.
 	A quote pair or a backslash can be used to quote them.
+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,
+`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`.
 If the alias expansion is prefixed with an exclamation point,
 it will be treated as a shell command.  For example, defining
 ` = !gitk --all --not ORIG_HEAD`, the invocation

  parent reply	other threads:[~2019-05-31 20:23 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-31 20:23 [PATCH 0/2] document alias accepting non-command first word Denton Liu
2019-05-31 20:23 ` [PATCH 1/2] config/alias.txt: change " and ' to ` Denton Liu
2019-05-31 20:23 ` Denton Liu [this message]
2019-06-05 12:37   ` [PATCH 2/2] config/alias.txt: document alias accepting non-command first word Johannes Schindelin
2019-06-05 20:10 ` [PATCH v2 0/2] Doc: " Denton Liu
2019-06-05 20:10   ` [PATCH v2 1/2] config/alias.txt: change " and ' to ` Denton Liu
2019-06-05 20:10   ` [PATCH v2 2/2] config/alias.txt: document alias accepting non-command first word Denton Liu
2019-06-06 12:48   ` [PATCH v2 0/2] Doc: " Johannes Schindelin

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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \

* 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.
Code repositories for project(s) associated with this public inbox

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 read-only IMAP folder(s) and NNTP newsgroup(s).