summaryrefslogtreecommitdiffstats
path: root/git-am.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2007-03-25 07:54:35 +0000
committerJunio C Hamano <junio@hera.kernel.org>2007-03-25 07:54:35 +0000
commit35e5755744795aed16e69dd2ad48b03022d698b5 (patch)
tree79959dba6c6a40253cfaf28101d19607312b47cf /git-am.html
parentb60308af319f44ed4baa08874c979cf9d8e7cc66 (diff)
downloadgit-htmldocs-35e5755744795aed16e69dd2ad48b03022d698b5.tar.gz
Autogenerated HTML docs for v1.5.1-rc1-63-g12d6
Diffstat (limited to 'git-am.html')
-rw-r--r--git-am.html37
1 files changed, 36 insertions, 1 deletions
diff --git a/git-am.html b/git-am.html
index cf5fead8f..864335468 100644
--- a/git-am.html
+++ b/git-am.html
@@ -417,6 +417,41 @@ default. You could use <tt>--no-utf8</tt> to override this.</p>
</div>
<h2>DISCUSSION</h2>
<div class="sectionbody">
+<p>The commit author name is taken from the "From: " line of the
+message, and commit author time is taken from the "Date: " line
+of the message. The "Subject: " line is used as the title of
+the commit, after stripping common prefix "[PATCH &lt;anything&gt;]".
+It is supposed to describe what the commit is about concisely as
+a one line text.</p>
+<p>The body of the message (iow, after a blank line that terminates
+RFC2822 headers) can begin with "Subject: " and "From: " lines
+that are different from those of the mail header, to override
+the values of these fields.</p>
+<p>The commit message is formed by the title taken from the
+"Subject: ", a blank line and the body of the message up to
+where the patch begins. Excess whitespaces at the end of the
+lines are automatically stripped.</p>
+<p>The patch is expected to be inline, directly following the
+message. Any line that is of form:</p>
+<ul>
+<li>
+<p>
+three-dashes and end-of-line, or
+</p>
+</li>
+<li>
+<p>
+a line that begins with "diff -", or
+</p>
+</li>
+<li>
+<p>
+a line that begins with "Index: "
+</p>
+</li>
+</ul>
+<p>is taken as the beginning of a patch, and the commit log message
+is terminated before the first occurrence of such a line.</p>
<p>When initially invoking it, you give it names of the mailboxes
to crunch. Upon seeing the first patch that does not apply, it
aborts in the middle, just like <em>git-applymbox</em> does. You can
@@ -459,7 +494,7 @@ names.</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 23-Mar-2007 10:46:02 UTC
+Last updated 25-Mar-2007 07:54:14 UTC
</div>
</div>
</body>