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] [\fB--stdout\fR]
114Prepare the patch series to send via email.
115This creates one file per patch in the series, plus one additional file for the
116cover letter if any.
117The patch series must have a base set with \fBgit series base\fR, to identify
118the series of patches to format.
119
120Each file contains one email in mbox format, ready to send, with email headers
121threading all the patches together.
122If the series has a cover letter, all of the patches will include headers to
123make them a reply to the cover letter; otherwise, all of the patches will
124include headers to make them a reply to the first patch.
125.RS
126.TP
127.BI --in-reply-to= Message-Id
128Make the first mail a reply to the specified Message-Id.
129The Message-Id may include or omit the surrounding angle brackets; git-series
130will add them if not present.
131.TP
132.B --stdout
133Write the entire patch series to stdout rather than to separate patch files.
134.RE
135
136.TP
137\fBgit series help\fR [\fIsubcommand\fR]
138Show help for \fBgit series\fR or a subcommand.
139Without arguments, shows a summary of the subcommands supported by \fBgit
140series\fR.
141.RS
142.TP
143\fIsubcommand\fR
144Show help for \fIsubcommand\fR.
145.RE
146
147.TP
148\fBgit series log\fR [\fB-p\fR|\fB--patch\fR]
149Show the history of the patch series.
150.RS
151.TP
152.BR -p | --patch
153Include a patch for each change committed to the series.
154.RE
155
156.TP
157\fBgit series rebase\fR [\fB-i\fR|\fB--interactive\fR] [\fIonto\fR]
158Rebase the patch series, either onto a new base, interactively, or both.
159The patch series must have a base set with \fBgit series base\fR, to identify
160the series of patches to rebase.
161.RS
162.TP
163\fIonto\fR
164Commit to rebase the series onto.
165This can use a commit hash, ref name, or special syntaxes such as refname^ or
166refname~2.
167.TP
168.BR -i | --interactive
169Interactively edit the list of commits.
170This uses the same format and syntax as \fBgit rebase -i\fR, to allow
171reordering, dropping, combining, or editing commits.
172.RE
173
174.TP
175\fBgit series req\fR [\fB-p\fR|\fB--patch\fR] \fIurl\fR \fItag\fR
176Generate a mail requesting a pull of the patch series.
177
178Before running this command, push the patch series to the repository at
179\fIurl\fR, as a tag or branch named \fItag\fR.
180
181A pull request for a signed or annotated tag will include the message from the
182tag.  The pull request will also include the cover letter if any, unless the
183tag message already contains the cover letter.  The subject of the mail will
184include the first line from the cover letter, or the name of the series if no
185cover letter.
186
187The patch series must have a base set with \fBgit series base\fR, to identify
188the series of patches to request a pull of.
189.RS
190.TP
191\fIurl\fR
192URL of the repository to pull from.
193.TP
194.TP
195\fItag\fR
196Name of a tag or branch to request a pull from.
197.TP
198.BR -p | --patch
199Include a patch showing the combined change made by all the patches in the series.
200This can help a reviewer see the effect of pulling the series.
201.RE
202
203.TP
204\fBgit series start\fR \fIname\fR
205Start a new patch series named \fIname\fR.
206
207.TP
208\fBgit series status\fR
209Show the status of the current patch series.
210
211This shows any changes staged for the next \fBgit series commit\fR, changes in
212the current working copy but not staged for the next \fBgit series commit\fR,
213and hints about the next commands to run.
214
215.TP
216\fBgit series unadd\fR \fIchange\fR
217Remove changes from the next \fBgit series commit\fR, undoing \fBgit series
218add\fR.
219
220The changes remain in the current working version of the series.
221.RS
222.TP
223\fIchange\fR...
224Changes to remove: any combination of "series", "base", and "cover".
225.RE
226
227.SH "SEE ALSO"
228.BR git (1)