aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorRyan Anderson <ryan@michonline.com>2005-07-31 04:17:25 -0400
committerJunio C Hamano <junkio@cox.net>2005-08-02 22:53:13 -0700
commit479cec960c20a5022e2cfc7e46c88817d8540758 (patch)
tree5c54e6e3024fd17ac1eb3a2fbf4a26f897434dc7 /Documentation
parent83b24437c2c6262eeb1e4b36cd9cbb28331c141a (diff)
downloadgit-479cec960c20a5022e2cfc7e46c88817d8540758.tar.gz
[PATCH] Add documentation for git-send-email-script
Signed-off-by: Ryan Anderson <ryan@michonline.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-send-email-script.txt61
1 files changed, 61 insertions, 0 deletions
diff --git a/Documentation/git-send-email-script.txt b/Documentation/git-send-email-script.txt
new file mode 100644
index 0000000000..97d5baed05
--- /dev/null
+++ b/Documentation/git-send-email-script.txt
@@ -0,0 +1,61 @@
+git-send-email-script(1)
+=======================
+v0.1, July 2005
+
+NAME
+----
+git-send-email-script - Send a collection of patches as emails
+
+
+SYNOPSIS
+--------
+'git-send-email-script' [options] <file|directory> [... file|directory]
+
+
+
+DESCRIPTION
+-----------
+Takes the patches given on the command line and emails them out.
+
+The header of the email is configurable by command line options. If not
+specified on the command line, the user will be prompted with a ReadLine
+enabled interface to provide the necessary information.
+
+The options available are:
+
+ --to
+ Specify the primary recipient of the emails generated.
+ Generally, this will be the upstream maintainer of the
+ project involved.
+
+ --from
+ Specify the sender of the emails. This will default to
+ the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
+ The user will still be prompted to confirm this entry.
+
+ --subject
+ Specify the initial subject of the email thread.
+
+ --in-reply-to
+ Specify the contents of the first In-Reply-To header.
+ Subsequent emails will refer to the previous email
+ instead of this.
+ When overriding on the command line, it may be necessary
+ to set this to a space. For example
+ --in-reply-to=" "
+
+Author
+------
+Written by Ryan Anderson <ryan@michonline.com>
+
+git-send-email-script is originally based upon
+send_lots_of_email.pl by Greg Kroah-Hartman.
+
+Documentation
+--------------
+Documentation by Ryan Anderson
+
+GIT
+---
+Part of the link:git.html[git] suite
+