@matheusbsbs / matheus-bagliano / commits / 2499857b0b
Fork 0

git-am documentation: describe what is taken from where.

Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Mar 24, 2007 at 03:08 UTC 2499857b0b5c1801da659e8bff976c1e038f3f3f
1 file changed +27
Documentation/git-am.txt
+27
@@ -87,6 +87,33 @@ default. You could use `--no-utf8` to override this.
87 DISCUSSION
88 ----------
89
90 +The commit author name is taken from the "From: " line of the
91 +message, and commit author time is taken from the "Date: " line
92 +of the message. The "Subject: " line is used as the title of
93 +the commit, after stripping common prefix "[PATCH <anything>]".
94 +It is supposed to describe what the commit is about concisely as
95 +a one line text.
96 +
97 +The body of the message (iow, after a blank line that terminates
98 +RFC2822 headers) can begin with "Subject: " and "From: " lines
99 +that are different from those of the mail header, to override
100 +the values of these fields.
101 +
102 +The commit message is formed by the title taken from the
103 +"Subject: ", a blank line and the body of the message up to
104 +where the patch begins. Excess whitespaces at the end of the
105 +lines are automatically stripped.
106 +
107 +The patch is expected to be inline, directly following the
108 +message. Any line that is of form:
109 +
110 +* three-dashes and end-of-line, or
111 +* a line that begins with "diff -", or
112 +* a line that begins with "Index: "
113 +
114 +is taken as the beginning of a patch, and the commit log message
115 +is terminated before the first occurrence of such a line.
116 +
117 When initially invoking it, you give it names of the mailboxes
118 to crunch. Upon seeing the first patch that does not apply, it
119 aborts in the middle, just like 'git-applymbox' does. You can