diff options
| author | Junio C Hamano <gitster@pobox.com> | 2009-09-07 15:25:37 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-09-07 15:25:37 -0700 |
| commit | b8711f520b35bde33b0e433b72e29d8f6b7551d9 (patch) | |
| tree | 2c7e8fc144067190dcc9e583e4120e68860391cf /Documentation | |
| parent | 2da9f8e370b08d4786e33ec95a07a4d6104eb83a (diff) | |
| parent | 43485d3d16e4fe221ac79fd53c0a2fe38f9ea5cb (diff) | |
| download | git-b8711f520b35bde33b0e433b72e29d8f6b7551d9.tar.gz git-b8711f520b35bde33b0e433b72e29d8f6b7551d9.tar.xz | |
Merge branch 'jc/mailinfo-scissors'
* jc/mailinfo-scissors:
mailinfo.scissors: new configuration
am/mailinfo: Disable scissors processing by default
Documentation: describe the scissors mark support of "git am"
Teach mailinfo to ignore everything before -- >8 -- mark
builtin-mailinfo.c: fix confusing internal API to mailinfo()
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-am.txt | 13 | ||||
| -rw-r--r-- | Documentation/git-mailinfo.txt | 16 |
2 files changed, 23 insertions, 6 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index fcacc9465..87781f4a7 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -13,7 +13,7 @@ SYNOPSIS [--3way] [--interactive] [--committer-date-is-author-date] [--ignore-date] [--ignore-space-change | --ignore-whitespace] [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>] - [--reject] [-q | --quiet] + [--reject] [-q | --quiet] [--scissors] [<mbox> | <Maildir>...] 'git am' (--skip | --resolved | --abort) @@ -39,6 +39,11 @@ OPTIONS --keep:: Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]). +-c:: +--scissors:: + Remove everything in body before a scissors line (see + linkgit:git-mailinfo[1]). + -q:: --quiet:: Be quiet. Only print error messages. @@ -128,10 +133,8 @@ the commit, after stripping common prefix "[PATCH <anything>]". The "Subject: " line is supposed to concisely describe what the commit is about in one line of text. -"From: " and "Subject: " lines starting the body (the rest of the -message after the blank line terminating the RFC2822 headers) -override the respective commit author name and title values taken -from the headers. +"From: " and "Subject: " lines starting the body override the respective +commit author name and title values taken from the headers. The commit message is formed by the title taken from the "Subject: ", a blank line and the body of the message up to diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 8d95aaa30..823ab82b5 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -8,7 +8,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message SYNOPSIS -------- -'git mailinfo' [-k] [-u | --encoding=<encoding> | -n] <msg> <patch> +'git mailinfo' [-k] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch> DESCRIPTION @@ -49,6 +49,20 @@ conversion, even with this flag. -n:: Disable all charset re-coding of the metadata. +--scissors:: + Remove everything in body before a scissors line. A line that + mainly consists of scissors (either ">8" or "8<") and perforation + (dash "-") marks is called a scissors line, and is used to request + the reader to cut the message at that line. If such a line + appears in the body of the message before the patch, everything + before it (including the scissors line itself) is ignored when + this option is used. ++ +This is useful if you want to begin your message in a discussion thread +with comments and suggestions on the message you are responding to, and to +conclude it with a patch submission, separating the discussion and the +beginning of the proposed commit log message with a scissors line. + <msg>:: The commit log message extracted from e-mail, usually except the title line which comes from e-mail Subject. |