1.TH git-series 1
  2
  3.SH NAME
  4git-series \- track changes to a patch series with git
  5
  6.SH SYNOPSIS
  7.nf
  8\fBgit series\fR [\fISUBCOMMAND\fR] [\fIOPTIONS\fR]
  9.fi
 10
 11.SH DESCRIPTION
 12.PP
 13\fBgit series\fR tracks changes to a patch series over time.
 14\fBgit series\fR also tracks a cover letter for the patch series, formats the
 15series for email, and prepares pull requests.
 16
 17Use \fBgit series start\fR \fIseriesname\fR to start a patch series
 18\fIseriesname\fR.
 19Use normal \fBgit\fR commands to commit changes, and use \fBgit series
 20status\fR to check what has changed.
 21Use \fBgit series cover\fR to add or edit a cover letter.
 22Use \fBgit series add\fR and \fBgit series commit\fR (or \fBgit series commit
 23-a\fR) to commit changes to the patch series.
 24Use \fBgit series rebase -i\fR to help rework or reorganize the patch series.
 25Use \fBgit series format\fR to prepare the patch series to send via email, or
 26\fBgit series req\fR to prepare a "please pull" mail.
 27
 28Running \fBgit series\fR without arguments shows the list of patch series,
 29marking the current patch series with a '*'.
 30
 31.SH SUBCOMMANDS
 32.TP
 33\fBgit series add\fR \fIchange\fR...
 34Add changes to the staging area for the next \fBgit series commit\fR.
 35.RS
 36.TP
 37\fIchange\fR...
 38Changes to add: any combination of "series", "base", and "cover".
 39.RE
 40
 41.TP
 42\fBgit series base\fR [\fB-d\fR|\fB--delete\fR] [\fIbase\fR]
 43Get or set the base commit for the patch series.
 44With no parameters, print the hash of the base commit.
 45With parameters, set or delete the base commit.
 46
 47This only changes the base in the working version of the patch series; use
 48\fBgit series add base\fR to add that change to the next \fBgit series
 49commit\fR, or use \fBgit series commit -a\fR to commit the new base and all
 50other changes to the series in one step.
 51.RS
 52.TP
 53\fIbase\fR
 54New base commit.
 55This can use a commit hash, ref name, or special syntaxes such as refname^ or
 56refname~2.
 57.TP
 58.BR -d | --delete
 59Delete the current base commit.
 60.RE
 61
 62.TP
 63\fBgit series checkout\fR \fIname\fR
 64Resume work on the patch series \fIname\fR; check out the current version as
 65HEAD.
 66
 67.TP
 68\fBgit series commit\fR [\fB-a\fR|\fB--all\fR] [\fB-m\fR \fImessage\fR] \
 69[\fB-v\fR|\fB--verbose\fR]
 70Record a new version of the patch series.
 71Without arguments, this will run an editor to edit a commit message, and then
 72commit the changes previously added with \fBgit series add\fR.
 73.RS
 74.TP
 75.BR -a | --all
 76Commit all changes, not just those added with \fBgit series add\fR.
 77.TP
 78\fB-m\fR \fImessage\fR
 79Use \fImessage\fR as the commit message, rather than running an editor.
 80.TP
 81.BR -v | --verbose
 82Show a diff of the commit in the editor, below the commit message, as a
 83reminder of the changes in the commit.
 84This diff will not appear in the commit message.
 85.RE
 86
 87.TP
 88\fBgit series cover\fR [\fB-d\fR|\fB--delete\fR]
 89Create or edit the cover letter for the patch series.
 90Without arguments, this will run an editor to edit the cover letter.
 91
 92This only changes the cover letter in the working version of the patch series;
 93use \fBgit series add cover\fR to add that change to the next \fBgit series
 94commit\fR, or use \fBgit series commit -a\fR to commit the new cover letter and
 95all other changes to the series in one step.
 96.RS
 97.TP
 98.BR -d | --delete
 99Delete the cover letter rather than editing it.
100.RE
101
102.TP
103\fBgit series delete\fR \fIname\fR
104Delete the series \fIname\fR, including any work in progress, staged or unstaged.
105
106.TP
107\fBgit series detach\fR
108Stop working on any patch series.
109Any changes in progress, staged or unstaged, will remain intact.
110To start working on the branch again, use \fBgit series checkout\fR.
111
112.TP
113\fBgit series format\fR [\fB--in-reply-to=\fR\fIMessage-Id\fR] \
114[\fB--no-from\fR] \
115[\fB-v\fR \fIN\fR | \fB--reroll-count=\fR\fIN\fR] \
116[\fB--rfc\fR] \
117[\fB--stdout\fR] \
118[\fB--subject-prefix=\fR\fISubject-Prefix\fR]
119Prepare the patch series to send via email.
120This creates one file per patch in the series, plus one additional file for the
121cover letter if any.
122The patch series must have a base set with \fBgit series base\fR, to identify
123the series of patches to format.
124
125Each file contains one email in mbox format, ready to send, with email headers
126threading all the patches together.
127If the series has a cover letter, all of the patches will include headers to
128make them a reply to the cover letter; otherwise, all of the patches will
129include headers to make them a reply to the first patch.
130.RS
131.TP
132.BI --in-reply-to= Message-Id
133Make the first mail a reply to the specified Message-Id.
134The Message-Id may include or omit the surrounding angle brackets; git-series
135will add them if not present.
136.TP
137.B --no-from
138By default, \fBgit series format\fR includes a "From:" line in the mail body
139for the commit author when formatting commits you didn't write; this allows you
140to send the patches as emails from your own address while preserving authorship
141information for each patch.
142\fBgit series format --no-from\fR will instead use the commit author as the
143"From:" address for each patch mail.
144Use this when producing patch files for purposes other than email.
145.TP
146\fB-v\fR \fIN\fR | \fB--reroll-count=\fB\fIN\fR
147Mark the patch series as PATCH v\fIN\fR.
148The patch filenames and mail subjects will include the version number.
149.TP
150.B --rfc
151Use [RFC PATCH] instead of the standard [PATCH] prefix.
152.TP
153.B --stdout
154Write the entire patch series to stdout rather than to separate patch files.
155.TP
156.BI --subject-prefix= Subject-Prefix
157Use [\fISubject-Prefix\fR] instead of the standard [PATCH] prefix.
158.RE
159
160.TP
161\fBgit series help\fR [\fIsubcommand\fR]
162Show help for \fBgit series\fR or a subcommand.
163Without arguments, shows a summary of the subcommands supported by \fBgit
164series\fR.
165.RS
166.TP
167\fIsubcommand\fR
168Show help for \fIsubcommand\fR.
169.RE
170
171.TP
172\fBgit series log\fR [\fB-p\fR|\fB--patch\fR]
173Show the history of the patch series.
174.RS
175.TP
176.BR -p | --patch
177Include a patch for each change committed to the series.
178.RE
179
180.TP
181\fBgit series rebase\fR [\fB-i\fR|\fB--interactive\fR] [\fIonto\fR]
182Rebase the patch series, either onto a new base, interactively, or both.
183The patch series must have a base set with \fBgit series base\fR, to identify
184the series of patches to rebase.
185.RS
186.TP
187\fIonto\fR
188Commit to rebase the series onto.
189This can use a commit hash, ref name, or special syntaxes such as refname^ or
190refname~2.
191.TP
192.BR -i | --interactive
193Interactively edit the list of commits.
194This uses the same format and syntax as \fBgit rebase -i\fR, to allow
195reordering, dropping, combining, or editing commits.
196.RE
197
198.TP
199\fBgit series req\fR [\fB-p\fR|\fB--patch\fR] \fIurl\fR \fItag\fR
200Generate a mail requesting a pull of the patch series.
201
202Before running this command, push the patch series to the repository at
203\fIurl\fR, as a tag or branch named \fItag\fR.
204
205A pull request for a signed or annotated tag will include the message from the
206tag.  The pull request will also include the cover letter if any, unless the
207tag message already contains the cover letter.  The subject of the mail will
208include the first line from the cover letter, or the name of the series if no
209cover letter.
210
211The patch series must have a base set with \fBgit series base\fR, to identify
212the series of patches to request a pull of.
213.RS
214.TP
215\fIurl\fR
216URL of the repository to pull from.
217.TP
218.TP
219\fItag\fR
220Name of a tag or branch to request a pull from.
221.TP
222.BR -p | --patch
223Include a patch showing the combined change made by all the patches in the series.
224This can help a reviewer see the effect of pulling the series.
225.RE
226
227.TP
228\fBgit series start\fR \fIname\fR
229Start a new patch series named \fIname\fR.
230
231.TP
232\fBgit series status\fR
233Show the status of the current patch series.
234
235This shows any changes staged for the next \fBgit series commit\fR, changes in
236the current working copy but not staged for the next \fBgit series commit\fR,
237and hints about the next commands to run.
238
239.TP
240\fBgit series unadd\fR \fIchange\fR
241Remove changes from the next \fBgit series commit\fR, undoing \fBgit series
242add\fR.
243
244The changes remain in the current working version of the series.
245.RS
246.TP
247\fIchange\fR...
248Changes to remove: any combination of "series", "base", and "cover".
249.RE
250
251.SH "SEE ALSO"
252.BR git (1)