summaryrefslogtreecommitdiffstats
path: root/git-format-patch.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-03-30 15:12:45 -0700
committerJunio C Hamano <gitster@pobox.com>2021-03-30 15:12:45 -0700
commit3818f89ec2ff1b3fe76412b01c315b47369ef1ee (patch)
tree9a416517ed6c2f068e1a3905235cafd96e57f62f /git-format-patch.html
parentaae21c9d9a0b8ddea3ffd56032b29f44fd4b9f8d (diff)
downloadgit-htmldocs-3818f89ec2ff1b3fe76412b01c315b47369ef1ee.tar.gz
Autogenerated HTML docs for v2.31.1-163-ga65ce
Diffstat (limited to 'git-format-patch.html')
-rw-r--r--git-format-patch.html32
1 files changed, 29 insertions, 3 deletions
diff --git a/git-format-patch.html b/git-format-patch.html
index f9929c432..a7bcc60f2 100644
--- a/git-format-patch.html
+++ b/git-format-patch.html
@@ -779,10 +779,36 @@ git-format-patch(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Prepare each commit with its patch in
-one file per commit, formatted to resemble UNIX mailbox format.
+<div class="paragraph"><p>Prepare each commit with its "patch" in
+one "message" per commit, formatted to resemble a UNIX mailbox.
The output of this command is convenient for e-mail submission or
for use with <em>git am</em>.</p></div>
+<div class="paragraph"><p>A "message" generated by the command consists of three parts:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+A brief metadata header that begins with <code>From &lt;commit&gt;</code>
+ with a fixed <code>Mon Sep 17 00:00:00 2001</code> datestamp to help programs
+ like "file(1)" to recognize that the file is an output from this
+ command, fields that record the author identity, the author date,
+ and the title of the change (taken from the first paragraph of the
+ commit log message).
+</p>
+</li>
+<li>
+<p>
+The second and subsequent paragraphs of the commit log message.
+</p>
+</li>
+<li>
+<p>
+The "patch", which is the "diff -p --stat" output (see
+ <a href="git-diff.html">git-diff(1)</a>) between the commit and its parent.
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>The log message and the patch is separated by a line with a
+three-dash line.</p></div>
<div class="paragraph"><p>There are two ways to specify which commits to operate on.</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
@@ -2523,7 +2549,7 @@ Extract three topmost commits from the current branch and format them
<div id="footer">
<div id="footer-text">
Last updated
- 2020-11-23 11:57:47 PST
+ 2021-03-30 15:09:45 PDT
</div>
</div>
</body>