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 cp\fR [\fIsource\fR] \fIdest\fR
104Copy the series \fIsource\fR to \fIdest\fR, including any work in progress,
105staged or unstaged.
106\fIsource\fR defaults to the current series if omitted.
107
108.TP
109\fBgit series delete\fR \fIname\fR
110Delete the series \fIname\fR, including any work in progress, staged or unstaged.
111
112.TP
113\fBgit series detach\fR
114Stop working on any patch series.
115Any changes in progress, staged or unstaged, will remain intact.
116To start working on the branch again, use \fBgit series checkout\fR.
117
118.TP
119\fBgit series format\fR [\fB--in-reply-to=\fR\fIMessage-Id\fR] \
120[\fB--no-from\fR] \
121[\fB-v\fR \fIN\fR | \fB--reroll-count=\fR\fIN\fR] \
122[\fB--rfc\fR] \
123[\fB--stdout\fR] \
124[\fB--subject-prefix=\fR\fISubject-Prefix\fR]
125Prepare the patch series to send via email.
126This creates one file per patch in the series, plus one additional file for the
127cover letter if any.
128The patch series must have a base set with \fBgit series base\fR, to identify
129the series of patches to format.
130
131Each file contains one email in mbox format, ready to send, with email headers
132threading all the patches together.
133If the series has a cover letter, all of the patches will include headers to
134make them a reply to the cover letter; otherwise, all of the patches will
135include headers to make them a reply to the first patch.
136.RS
137.TP
138.BI --in-reply-to= Message-Id
139Make the first mail a reply to the specified Message-Id.
140The Message-Id may include or omit the surrounding angle brackets; git-series
141will add them if not present.
142.TP
143.B --no-from
144By default, \fBgit series format\fR includes a "From:" line in the mail body
145for the commit author when formatting commits you didn't write; this allows you
146to send the patches as emails from your own address while preserving authorship
147information for each patch.
148\fBgit series format --no-from\fR will instead use the commit author as the
149"From:" address for each patch mail.
150Use this when producing patch files for purposes other than email.
151.TP
152\fB-v\fR \fIN\fR | \fB--reroll-count=\fB\fIN\fR
153Mark the patch series as PATCH v\fIN\fR.
154The patch filenames and mail subjects will include the version number.
155.TP
156.B --rfc
157Use [RFC PATCH] instead of the standard [PATCH] prefix.
158.TP
159.B --stdout
160Write the entire patch series to stdout rather than to separate patch files.
161.TP
162.BI --subject-prefix= Subject-Prefix
163Use [\fISubject-Prefix\fR] instead of the standard [PATCH] prefix.
164.RE
165
166.TP
167\fBgit series help\fR [\fIsubcommand\fR]
168Show help for \fBgit series\fR or a subcommand.
169Without arguments, shows a summary of the subcommands supported by \fBgit
170series\fR.
171.RS
172.TP
173\fIsubcommand\fR
174Show help for \fIsubcommand\fR.
175.RE
176
177.TP
178\fBgit series log\fR [\fB-p\fR|\fB--patch\fR]
179Show the history of the patch series.
180.RS
181.TP
182.BR -p | --patch
183Include a patch for each change committed to the series.
184.RE
185
186.TP
187\fBgit series mv\fR [\fIsource\fR] \fIdest\fR
188Move (rename) the series \fIsource\fR to \fIdest\fR, including any work in
189progress, staged or unstaged.
190\fIsource\fR defaults to the current series if omitted.
191Moving the current series will make the destination the current series.
192
193You can also invoke this as \fBgit series rename\fR.
194
195.TP
196\fBgit series rebase\fR [\fB-i\fR|\fB--interactive\fR] [\fIonto\fR]
197Rebase the patch series, either onto a new base, interactively, or both.
198The patch series must have a base set with \fBgit series base\fR, to identify
199the series of patches to rebase.
200.RS
201.TP
202\fIonto\fR
203Commit to rebase the series onto.
204This can use a commit hash, ref name, or special syntaxes such as refname^ or
205refname~2.
206.TP
207.BR -i | --interactive
208Interactively edit the list of commits.
209This uses the same format and syntax as \fBgit rebase -i\fR, to allow
210reordering, dropping, combining, or editing commits.
211.RE
212
213.TP
214\fBgit series req\fR [\fB-p\fR|\fB--patch\fR] \fIurl\fR \fItag\fR
215Generate a mail requesting a pull of the patch series.
216
217Before running this command, push the patch series to the repository at
218\fIurl\fR, as a tag or branch named \fItag\fR.
219
220A pull request for a signed or annotated tag will include the message from the
221tag.  The pull request will also include the cover letter if any, unless the
222tag message already contains the cover letter.  The subject of the mail will
223include the first line from the cover letter, or the name of the series if no
224cover letter.
225
226The patch series must have a base set with \fBgit series base\fR, to identify
227the series of patches to request a pull of.
228.RS
229.TP
230\fIurl\fR
231URL of the repository to pull from.
232.TP
233.TP
234\fItag\fR
235Name of a tag or branch to request a pull from.
236.TP
237.BR -p | --patch
238Include a patch showing the combined change made by all the patches in the series.
239This can help a reviewer see the effect of pulling the series.
240.RE
241
242.TP
243\fBgit series start\fR \fIname\fR
244Start a new patch series named \fIname\fR.
245
246.TP
247\fBgit series status\fR
248Show the status of the current patch series.
249
250This shows any changes staged for the next \fBgit series commit\fR, changes in
251the current working copy but not staged for the next \fBgit series commit\fR,
252and hints about the next commands to run.
253
254.TP
255\fBgit series unadd\fR \fIchange\fR
256Remove changes from the next \fBgit series commit\fR, undoing \fBgit series
257add\fR.
258
259The changes remain in the current working version of the series.
260.RS
261.TP
262\fIchange\fR...
263Changes to remove: any combination of "series", "base", and "cover".
264.RE
265
266.SH "SEE ALSO"
267.BR git (1)