man1/git-format-patch.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-FORMAT-PATCH" 1 "" "" ""
  21 .SH NAME
  22 git-format-patch \- Prepare patches for e-mail submission
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIgit\-format\-patch\fR [\-n | \-k] [\-o <dir> | \-\-stdout] [\-\-attach]
  27                    [\-s | \-\-signoff] [\-\-diff\-options] [\-\-start\-number <n>]
  28                    <since>[\&.\&.<until>]
  29 .fi
  30
  31 .SH "DESCRIPTION"
  32
  33
  34 Prepare each commit between <since> and <until> with its patch in one file per commit, formatted to resemble UNIX mailbox format\&. If \&.\&.<until> is not specified, the head of the current working tree is implied\&.
  35
  36
  37 The output of this command is convenient for e\-mail submission or for use with \fBgit\-am\fR(1)\&.
  38
  39
  40 Each output file is numbered sequentially from 1, and uses the first line of the commit message (massaged for pathname safety) as the filename\&. The names of the output files are printed to standard output, unless the \-\-stdout option is specified\&.
  41
  42
  43 If \-o is specified, output files are created in <dir>\&. Otherwise they are created in the current working directory\&.
  44
  45
  46 If \-n is specified, instead of "[PATCH] Subject", the first line is formatted as "[PATCH n/m] Subject"\&.
  47
  48 .SH "OPTIONS"
  49
  50 .TP
  51 \-o|\-\-output\-directory <dir>
  52 Use <dir> to store the resulting files, instead of the current working directory\&.
  53
  54 .TP
  55 \-n|\-\-numbered
  56 Name output in \fI[PATCH n/m]\fR format\&.
  57
  58 .TP
  59 \-\-start\-number <n>
  60 Start numbering the patches at <n> instead of 1\&.
  61
  62 .TP
  63 \-k|\-\-keep\-subject
  64 Do not strip/add \fI[PATCH]\fR from the first line of the commit log message\&.
  65
  66 .TP
  67 \-s|\-\-signoff
  68 Add Signed\-off\-by: line to the commit message, using the committer identity of yourself\&.
  69
  70 .TP
  71 \-\-stdout
  72 Print all commits to the standard output in mbox format, instead of creating a file for each one\&.
  73
  74 .TP
  75 \-\-attach
  76 Create attachments instead of inlining patches\&.
  77
  78 .SH "CONFIGURATION"
  79
  80
  81 You can specify extra mail header lines to be added to each message in the repository configuration as follows:
  82
  83 .nf
  84 headers = "Organization: git\-foo\\n"
  85 .fi
  86
  87 .SH "EXAMPLES"
  88
  89 .TP
  90 git\-format\-patch \-k \-\-stdout R1\&.\&.R2 | git\-am \-3 \-k
  91 Extract commits between revisions R1 and R2, and apply them on top of the current branch using git\-am to cherry\-pick them\&.
  92
  93 .TP
  94 git\-format\-patch origin
  95 Extract all commits which are in the current branch but not in the origin branch\&. For each commit a separate file is created in the current directory\&.
  96
  97 .TP
  98 git\-format\-patch \-M \-B origin
  99 The same as the previous one\&. Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch\&. A renaming patch reduces the amount of text output, and generally makes it easier to review it\&. Note that the "patch" program does not understand renaming patches, so use it only when you know the recipient uses git to apply your patch\&.
 100
 101 .SH "SEE ALSO"
 102
 103
 104 \fBgit\-am\fR(1), \fBgit\-send\-email\fR(1)
 105
 106 .SH "AUTHOR"
 107
 108
 109 Written by Junio C Hamano <junkio@cox\&.net>
 110
 111 .SH "DOCUMENTATION"
 112
 113
 114 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 115
 116 .SH "GIT"
 117
 118
 119 Part of the \fBgit\fR(7) suite
 120