summaryrefslogtreecommitdiff
path: root/Documentation/git-send-email.txt
diff options
context:
space:
mode:
authorJacob Keller <jacob.keller@gmail.com>2015-11-19 22:52:11 (GMT)
committerJeff King <peff@peff.net>2015-11-20 13:02:06 (GMT)
commit17b7a8324402ab1e5bb66adb287e5463757c9326 (patch)
tree3dcd180aa22323de6b1a902226777284f40e485a /Documentation/git-send-email.txt
parent0c83680e9c047170614fb08ef222ea4f460e514d (diff)
downloadgit-17b7a8324402ab1e5bb66adb287e5463757c9326.zip
git-17b7a8324402ab1e5bb66adb287e5463757c9326.tar.gz
git-17b7a8324402ab1e5bb66adb287e5463757c9326.tar.bz2
sendemail: teach git-send-email to dump alias names
Add an option "--dump-aliases" which changes the default behavior of git-send-email. This mode will simply read the alias files configured by sendemail.aliasesfile and sendemail.aliasfiletype and dump a list of all configured aliases, one per line. The intended use case for this option is the bash-completion script which will use it to autocomplete aliases on the options which take addresses. Add some tests for the new option using various alias file formats. A possible future extension to the alias dump format could be done by extending the --dump-aliases to take an optional argument defining the format to display. This has not been done in this patch as no user of this information has been identified. Signed-off-by: Jacob Keller <jacob.keller@gmail.com> Signed-off-by: Jeff King <peff@peff.net>
Diffstat (limited to 'Documentation/git-send-email.txt')
-rw-r--r--Documentation/git-send-email.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index b9134d2..771a7b5 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -10,6 +10,7 @@ SYNOPSIS
--------
[verse]
'git send-email' [options] <file|directory|rev-list options>...
+'git send-email' --dump-aliases
DESCRIPTION
@@ -387,6 +388,16 @@ default to '--validate'.
Send emails even if safety checks would prevent it.
+Information
+~~~~~~~~~~~
+
+--dump-aliases::
+ Instead of the normal operation, dump the shorthand alias names from
+ the configured alias file(s), one per line in alphabetical order. Note,
+ this only includes the alias name and not its expanded email addresses.
+ See 'sendemail.aliasesfile' for more information about aliases.
+
+
CONFIGURATION
-------------