summaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
blob: a1483ffd0f865eb486686d7c8050090b389a81c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
git-format-patch(1)
===================
 
NAME
----
git-format-patch - Prepare patches for e-mail submission.
 
 
SYNOPSIS
--------
'git-format-patch' [-n][-o <dir>][-k][--mbox][--diff-options] <his> [<mine>]
 
DESCRIPTION
-----------
Prepare each commit with its patch since <mine> head forked from
<his> head, one file per patch, for e-mail submission.  Each
output file is numbered sequentially from 1, and uses the first
line of the commit message (massaged for pathname safety) as the
filename.
 
When -o is specified, output files are created in that
directory; otherwise in the current working directory.
 
When -n is specified, instead of "[PATCH] Subject", the first
line is formatted as "[PATCH N/M] Subject", unless you have only
one patch.
 
When --mbox is specified, the output is formatted to resemble
UNIX mailbox format, and can be concatenated together for
processing with applymbox.
 
 
OPTIONS
-------
-o <dir>::
	Use <dir> to store the resulting files, instead of the
	current working directory.
 
-n::
	Name output in '[PATCH n/m]' format.
 
-k::
	Do not strip/add '[PATCH]' from the first line of the
	commit log message.
 
--author, --date::
	Output From: and Date: headers for commits made by
	yourself as well.  Usually these are output only for
	commits made by people other than yourself.
 
--mbox::
	Format the output files for closer to mbox format by
	adding a phony Unix "From " line, so they can be
	concatenated together and fed to `git-applymbox`.
	Implies --author and --date.
 
 
Author
------
Written by Junio C Hamano <junkio@cox.net>
 
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the gitlink:git[7] suite