aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-send-email.txt
diff options
context:
space:
mode:
authorJonas Fonseca <fonseca@diku.dk>2005-10-03 19:16:30 +0200
committerJunio C Hamano <junkio@cox.net>2005-10-03 13:23:47 -0700
commitdf8baa42fe4eeb5a021ac262caf601f44d2a5746 (patch)
treea2e2c531e7e2718451f8357902ba3bdcc6571804 /Documentation/git-send-email.txt
parent5a82b4fb3e547c4aa14cd417790b3f925713a422 (diff)
downloadgit-df8baa42fe4eeb5a021ac262caf601f44d2a5746.tar.gz
git-df8baa42fe4eeb5a021ac262caf601f44d2a5746.tar.xz
[PATCH] Random documentation fixes
The fixes focuses on improving the HTML output. Most noteworthy: - Fix the Makefile to also make various *.html files depend on included files. - Consistently use 'NOTE: ...' instead of '[ ... ]' for additional info. - Fix ending '::' for description lists in OPTION section etc. - Fix paragraphs in description lists ending up as preformated text. - Always use listingblocks (preformatted text wrapped in lines with -----) for examples that span empty lines, so they are put in only one HTML block. - Use '1.' instead of '(1)' for numbered lists. - Fix linking to other GIT docs. - git-rev-list.txt: put option descriptions in an OPTION section. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-send-email.txt')
-rw-r--r--Documentation/git-send-email.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index a2763bd74..b95e33db5 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -21,35 +21,37 @@ 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.
+OPTIONS
+-------
The options available are:
- --to
+--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the
project involved.
- --from
+--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.
- --compose
+--compose::
Use \$EDITOR to edit an introductory message for the
patch series.
- --subject
+--subject::
Specify the initial subject of the email thread.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
- --in-reply-to
+--in-reply-to::
Specify the contents of the first In-Reply-To header.
Subsequent emails will refer to the previous email
instead of this if --chain-reply-to is set (the default)
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
- --chain-reply-to, --no-chain-reply-to
+--chain-reply-to, --no-chain-reply-to::
If this is set, each email will be sent as a reply to the previous
email sent. If disabled with "--no-chain-reply-to", all emails after
the first will be sent as replies to the first email sent. When using
@@ -57,7 +59,7 @@ The options available are:
entire patch series.
Default is --chain-reply-to
- --smtp-server
+--smtp-server::
If set, specifies the outgoing SMTP server to use. Defaults to
localhost.