blob: e36857dedea1d0dbafa41732aaf9bf0988d63f38 [file] [log] [blame]
Simon Glass0d24de92012-01-14 15:12:45 +00001# Copyright (c) 2011 The Chromium OS Authors.
2#
Wolfgang Denk1a459662013-07-08 09:37:19 +02003# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00004#
5
6What is this?
7=============
8
9This tool is a Python script which:
10- Creates patch directly from your branch
11- Cleans them up by removing unwanted tags
12- Inserts a cover letter with change lists
13- Runs the patches through checkpatch.pl and its own checks
14- Optionally emails them out to selected people
15
16It is intended to automate patch creation and make it a less
17error-prone process. It is useful for U-Boot and Linux work so far,
18since it uses the checkpatch.pl script.
19
20It is configured almost entirely by tags it finds in your commits.
21This means that you can work on a number of different branches at
22once, and keep the settings with each branch rather than having to
23git format-patch, git send-email, etc. with the correct parameters
24each time. So for example if you put:
25
26Series-to: fred.blogs@napier.co.nz
27
28in one of your commits, the series will be sent there.
29
Simon Glass983a2742014-09-14 20:23:17 -060030In Linux and U-Boot this will also call get_maintainer.pl on each of your
31patches automatically (unless you use -m to disable this).
Doug Anderson21a19d72012-12-03 14:43:16 +000032
Simon Glass0d24de92012-01-14 15:12:45 +000033
34How to use this tool
35====================
36
37This tool requires a certain way of working:
38
39- Maintain a number of branches, one for each patch series you are
40working on
41- Add tags into the commits within each branch to indicate where the
42series should be sent, cover letter, version, etc. Most of these are
43normally in the top commit so it is easy to change them with 'git
44commit --amend'
45- Each branch tracks the upstream branch, so that this script can
46automatically determine the number of commits in it (optional)
47- Check out a branch, and run this script to create and send out your
48patches. Weeks later, change the patches and repeat, knowing that you
49will get a consistent result each time.
50
51
52How to configure it
53===================
54
Simon Glass3d4de982014-10-03 20:40:36 -060055For most cases of using patman for U-Boot development, patman can use the
56file 'doc/git-mailrc' in your U-Boot directory to supply the email aliases
57you need. To make this work, tell git where to find the file by typing
58this once:
Doug Anderson21a19d72012-12-03 14:43:16 +000059
Simon Glass3d4de982014-10-03 20:40:36 -060060 git config sendemail.aliasesfile doc/git-mailrc
61
62For both Linux and U-Boot the 'scripts/get_maintainer.pl' handles figuring
63out where to send patches pretty well.
Simon Glass0d24de92012-01-14 15:12:45 +000064
Vikram Narayanan87d65552012-05-23 09:01:06 +000065During the first run patman creates a config file for you by taking the default
66user name and email address from the global .gitconfig file.
67
Vikram Narayanan2b36c752012-05-23 08:58:58 +000068To add your own, create a file ~/.patman like this:
Simon Glass0d24de92012-01-14 15:12:45 +000069
70>>>>
71# patman alias file
72
73[alias]
74me: Simon Glass <sjg@chromium.org>
75
76u-boot: U-Boot Mailing List <u-boot@lists.denx.de>
77wolfgang: Wolfgang Denk <wd@denx.de>
78others: Mike Frysinger <vapier@gentoo.org>, Fred Bloggs <f.bloggs@napier.net>
79
80<<<<
81
82Aliases are recursive.
83
84The checkpatch.pl in the U-Boot tools/ subdirectory will be located and
85used. Failing that you can put it into your path or ~/bin/checkpatch.pl
86
87
Doug Anderson8568bae2012-12-03 14:43:17 +000088If you want to change the defaults for patman's command-line arguments,
89you can add a [settings] section to your .patman file. This can be used
90for any command line option by referring to the "dest" for the option in
91patman.py. For reference, the useful ones (at the moment) shown below
92(all with the non-default setting):
93
94>>>
95
96[settings]
97ignore_errors: True
98process_tags: False
99verbose: True
100
101<<<
102
103
Doug Andersona1dcee82012-12-03 14:43:18 +0000104If you want to adjust settings (or aliases) that affect just a single
105project you can add a section that looks like [project_settings] or
106[project_alias]. If you want to use tags for your linux work, you could
107do:
108
109>>>
110
111[linux_settings]
112process_tags: True
113
114<<<
115
116
Simon Glass0d24de92012-01-14 15:12:45 +0000117How to run it
118=============
119
120First do a dry run:
121
Vikram Narayanan330a0912012-04-27 06:39:31 +0000122$ ./tools/patman/patman -n
Simon Glass0d24de92012-01-14 15:12:45 +0000123
124If it can't detect the upstream branch, try telling it how many patches
125there are in your series:
126
Vikram Narayanan330a0912012-04-27 06:39:31 +0000127$ ./tools/patman/patman -n -c5
Simon Glass0d24de92012-01-14 15:12:45 +0000128
129This will create patch files in your current directory and tell you who
130it is thinking of sending them to. Take a look at the patch files.
131
Vikram Narayanan330a0912012-04-27 06:39:31 +0000132$ ./tools/patman/patman -n -c5 -s1
Simon Glass0d24de92012-01-14 15:12:45 +0000133
134Similar to the above, but skip the first commit and take the next 5. This
135is useful if your top commit is for setting up testing.
136
137
Chris Packham488d19c2015-07-22 21:21:46 +1200138How to install it
139=================
140
Bin Menga1875592016-02-05 19:30:11 -0800141The most up to date version of patman can be found in the U-Boot sources.
Chris Packham488d19c2015-07-22 21:21:46 +1200142However to use it on other projects it may be more convenient to install it as
143a standalone application. A distutils installer is included, this can be used
144to install patman:
145
146$ cd tools/patman && python setup.py install
147
148
Simon Glass0d24de92012-01-14 15:12:45 +0000149How to add tags
150===============
151
152To make this script useful you must add tags like the following into any
153commit. Most can only appear once in the whole series.
154
155Series-to: email / alias
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200156 Email address / alias to send patch series to (you can add this
157 multiple times)
Simon Glass0d24de92012-01-14 15:12:45 +0000158
159Series-cc: email / alias, ...
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200160 Email address / alias to Cc patch series to (you can add this
161 multiple times)
Simon Glass0d24de92012-01-14 15:12:45 +0000162
163Series-version: n
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200164 Sets the version number of this patch series
Simon Glass0d24de92012-01-14 15:12:45 +0000165
166Series-prefix: prefix
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200167 Sets the subject prefix. Normally empty but it can be RFC for
Wu, Josh3871cd82015-04-15 10:25:18 +0800168 RFC patches, or RESEND if you are being ignored. The patch subject
169 is like [RFC PATCH] or [RESEND PATCH].
170 In the meantime, git format.subjectprefix option will be added as
171 well. If your format.subjectprefix is set to InternalProject, then
172 the patch shows like: [InternalProject][RFC/RESEND PATCH]
Simon Glass0d24de92012-01-14 15:12:45 +0000173
Simon Glassef0e9de2012-09-27 15:06:02 +0000174Series-name: name
175 Sets the name of the series. You don't need to have a name, and
176 patman does not yet use it, but it is convenient to put the branch
177 name here to help you keep track of multiple upstreaming efforts.
178
Simon Glass0d24de92012-01-14 15:12:45 +0000179Cover-letter:
180This is the patch set title
181blah blah
182more blah blah
183END
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200184 Sets the cover letter contents for the series. The first line
185 will become the subject of the cover letter
Simon Glass0d24de92012-01-14 15:12:45 +0000186
Simon Glassfe2f8d92013-03-20 16:43:00 +0000187Cover-letter-cc: email / alias
188 Additional email addresses / aliases to send cover letter to (you
189 can add this multiple times)
190
Simon Glass0d24de92012-01-14 15:12:45 +0000191Series-notes:
192blah blah
193blah blah
194more blah blah
195END
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200196 Sets some notes for the patch series, which you don't want in
197 the commit messages, but do want to send, The notes are joined
198 together and put after the cover letter. Can appear multiple
199 times.
Simon Glass0d24de92012-01-14 15:12:45 +0000200
Albert ARIBAUD5c8fdd92013-11-12 11:14:41 +0100201Commit-notes:
202blah blah
203blah blah
204more blah blah
205END
206 Similar, but for a single commit (patch). These notes will appear
207 immediately below the --- cut in the patch file.
208
Simon Glass0d24de92012-01-14 15:12:45 +0000209 Signed-off-by: Their Name <email>
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200210 A sign-off is added automatically to your patches (this is
211 probably a bug). If you put this tag in your patches, it will
212 override the default signoff that patman automatically adds.
Simon Glass102061b2014-04-20 10:50:14 -0600213 Multiple duplicate signoffs will be removed.
Simon Glass0d24de92012-01-14 15:12:45 +0000214
215 Tested-by: Their Name <email>
Doug Anderson28b35942013-03-15 13:24:05 +0000216 Reviewed-by: Their Name <email>
Simon Glass0d24de92012-01-14 15:12:45 +0000217 Acked-by: Their Name <email>
Doug Anderson28b35942013-03-15 13:24:05 +0000218 These indicate that someone has tested/reviewed/acked your patch.
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200219 When you get this reply on the mailing list, you can add this
220 tag to the relevant commit and the script will include it when
221 you send out the next version. If 'Tested-by:' is set to
222 yourself, it will be removed. No one will believe you.
Simon Glass0d24de92012-01-14 15:12:45 +0000223
224Series-changes: n
225- Guinea pig moved into its cage
226- Other changes ending with a blank line
227<blank line>
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200228 This can appear in any commit. It lists the changes for a
229 particular version n of that commit. The change list is
230 created based on this information. Each commit gets its own
231 change list and also the whole thing is repeated in the cover
232 letter (where duplicate change lines are merged).
Simon Glass0d24de92012-01-14 15:12:45 +0000233
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200234 By adding your change lists into your commits it is easier to
235 keep track of what happened. When you amend a commit, remember
236 to update the log there and then, knowing that the script will
237 do the rest.
Simon Glass0d24de92012-01-14 15:12:45 +0000238
Simon Glass659c89d2014-02-16 08:23:47 -0700239Patch-cc: Their Name <email>
240 This copies a single patch to another email address. Note that the
241 Cc: used by git send-email is ignored by patman, but will be
242 interpreted by git send-email if you use it.
Simon Glass0d24de92012-01-14 15:12:45 +0000243
Simon Glass645b2712013-03-26 13:09:44 +0000244Series-process-log: sort, uniq
245 This tells patman to sort and/or uniq the change logs. It is
246 assumed that each change log entry is only a single line long.
247 Use 'sort' to sort the entries, and 'uniq' to include only
248 unique entries. If omitted, no change log processing is done.
249 Separate each tag with a comma.
250
Simon Glass0d24de92012-01-14 15:12:45 +0000251Various other tags are silently removed, like these Chrome OS and
252Gerrit tags:
253
254BUG=...
255TEST=...
256Change-Id:
257Review URL:
258Reviewed-on:
Albert ARIBAUD5c8fdd92013-11-12 11:14:41 +0100259Commit-xxxx: (except Commit-notes)
Simon Glass0d24de92012-01-14 15:12:45 +0000260
261Exercise for the reader: Try adding some tags to one of your current
262patch series and see how the patches turn out.
263
264
265Where Patches Are Sent
266======================
267
Vikram Narayanan17132472012-04-25 05:45:05 +0000268Once the patches are created, patman sends them using git send-email. The
Simon Glass0d24de92012-01-14 15:12:45 +0000269whole series is sent to the recipients in Series-to: and Series-cc.
Simon Glass659c89d2014-02-16 08:23:47 -0700270You can Cc individual patches to other people with the Patch-cc: tag. Tags
271in the subject are also picked up to Cc patches. For example, a commit like
272this:
Simon Glass0d24de92012-01-14 15:12:45 +0000273
274>>>>
275commit 10212537b85ff9b6e09c82045127522c0f0db981
276Author: Mike Frysinger <vapier@gentoo.org>
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200277Date: Mon Nov 7 23:18:44 2011 -0500
Simon Glass0d24de92012-01-14 15:12:45 +0000278
279 x86: arm: add a git mailrc file for maintainers
280
281 This should make sending out e-mails to the right people easier.
282
Simon Glass659c89d2014-02-16 08:23:47 -0700283 Patch-cc: sandbox, mikef, ag
284 Patch-cc: afleming
Simon Glass0d24de92012-01-14 15:12:45 +0000285<<<<
286
287will create a patch which is copied to x86, arm, sandbox, mikef, ag and
288afleming.
289
Simon Glass659c89d2014-02-16 08:23:47 -0700290If you have a cover letter it will get sent to the union of the Patch-cc
291lists of all of the other patches. If you want to sent it to additional
292people you can add a tag:
Simon Glassfe2f8d92013-03-20 16:43:00 +0000293
294Cover-letter-cc: <list of addresses>
295
296These people will get the cover letter even if they are not on the To/Cc
297list for any of the patches.
Doug Anderson31187252012-12-03 14:40:43 +0000298
Simon Glass0d24de92012-01-14 15:12:45 +0000299
300Example Work Flow
301=================
302
303The basic workflow is to create your commits, add some tags to the top
304commit, and type 'patman' to check and send them.
305
306Here is an example workflow for a series of 4 patches. Let's say you have
307these rather contrived patches in the following order in branch us-cmd in
308your tree where 'us' means your upstreaming activity (newest to oldest as
309output by git log --oneline):
310
311 7c7909c wip
312 89234f5 Don't include standard parser if hush is used
313 8d640a7 mmc: sparc: Stop using builtin_run_command()
314 0c859a9 Rename run_command2() to run_command()
315 a74443f sandbox: Rename run_command() to builtin_run_command()
316
317The first patch is some test things that enable your code to be compiled,
318but that you don't want to submit because there is an existing patch for it
319on the list. So you can tell patman to create and check some patches
320(skipping the first patch) with:
321
322 patman -s1 -n
323
324If you want to do all of them including the work-in-progress one, then
325(if you are tracking an upstream branch):
326
327 patman -n
328
329Let's say that patman reports an error in the second patch. Then:
330
331 git rebase -i HEAD~6
332 <change 'pick' to 'edit' in 89234f5>
333 <use editor to make code changes>
334 git add -u
335 git rebase --continue
336
337Now you have an updated patch series. To check it:
338
339 patman -s1 -n
340
341Let's say it is now clean and you want to send it. Now you need to set up
342the destination. So amend the top commit with:
343
344 git commit --amend
345
346Use your editor to add some tags, so that the whole commit message is:
347
348 The current run_command() is really only one of the options, with
349 hush providing the other. It really shouldn't be called directly
350 in case the hush parser is bring used, so rename this function to
351 better explain its purpose.
352
353 Series-to: u-boot
354 Series-cc: bfin, marex
355 Series-prefix: RFC
356 Cover-letter:
357 Unified command execution in one place
358
359 At present two parsers have similar code to execute commands. Also
360 cmd_usage() is called all over the place. This series adds a single
361 function which processes commands called cmd_process().
362 END
363
364 Change-Id: Ica71a14c1f0ecb5650f771a32fecb8d2eb9d8a17
365
366
367You want this to be an RFC and Cc the whole series to the bfin alias and
368to Marek. Two of the patches have tags (those are the bits at the front of
369the subject that say mmc: sparc: and sandbox:), so 8d640a7 will be Cc'd to
370mmc and sparc, and the last one to sandbox.
371
372Now to send the patches, take off the -n flag:
373
374 patman -s1
375
376The patches will be created, shown in your editor, and then sent along with
377the cover letter. Note that patman's tags are automatically removed so that
378people on the list don't see your secret info.
379
380Of course patches often attract comments and you need to make some updates.
381Let's say one person sent comments and you get an Acked-by: on one patch.
382Also, the patch on the list that you were waiting for has been merged,
383so you can drop your wip commit. So you resync with upstream:
384
Wolfgang Denk2790bf62012-04-21 18:55:26 +0200385 git fetch origin (or whatever upstream is called)
Simon Glass0d24de92012-01-14 15:12:45 +0000386 git rebase origin/master
387
388and use git rebase -i to edit the commits, dropping the wip one. You add
389the ack tag to one commit:
390
391 Acked-by: Heiko Schocher <hs@denx.de>
392
393update the Series-cc: in the top commit:
394
395 Series-cc: bfin, marex, Heiko Schocher <hs@denx.de>
396
397and remove the Series-prefix: tag since it it isn't an RFC any more. The
398series is now version two, so the series info in the top commit looks like
399this:
400
401 Series-to: u-boot
402 Series-cc: bfin, marex, Heiko Schocher <hs@denx.de>
403 Series-version: 2
404 Cover-letter:
405 ...
406
407Finally, you need to add a change log to the two commits you changed. You
408add change logs to each individual commit where the changes happened, like
409this:
410
411 Series-changes: 2
412 - Updated the command decoder to reduce code size
413 - Wound the torque propounder up a little more
414
415(note the blank line at the end of the list)
416
417When you run patman it will collect all the change logs from the different
418commits and combine them into the cover letter, if you have one. So finally
419you have a new series of commits:
420
421 faeb973 Don't include standard parser if hush is used
422 1b2f2fe mmc: sparc: Stop using builtin_run_command()
423 cfbe330 Rename run_command2() to run_command()
424 0682677 sandbox: Rename run_command() to builtin_run_command()
425
426so to send them:
427
428 patman
429
430and it will create and send the version 2 series.
431
432General points:
433
4341. When you change back to the us-cmd branch days or weeks later all your
435information is still there, safely stored in the commits. You don't need
436to remember what version you are up to, who you sent the last lot of patches
437to, or anything about the change logs.
438
4392. If you put tags in the subject, patman will Cc the maintainers
440automatically in many cases.
441
4423. If you want to keep the commits from each series you sent so that you can
443compare change and see what you did, you can either create a new branch for
444each version, or just tag the branch before you start changing it:
445
446 git tag sent/us-cmd-rfc
447 ...later...
448 git tag sent/us-cmd-v2
449
4504. If you want to modify the patches a little before sending, you can do
451this in your editor, but be careful!
452
4535. If you want to run git send-email yourself, use the -n flag which will
454print out the command line patman would have used.
455
4566. It is a good idea to add the change log info as you change the commit,
457not later when you can't remember which patch you changed. You can always
458go back and change or remove logs from commits.
459
460
461Other thoughts
462==============
463
464This script has been split into sensible files but still needs work.
465Most of these are indicated by a TODO in the code.
466
467It would be nice if this could handle the In-reply-to side of things.
468
Gerhard Sittigc8605bb2013-07-14 11:27:45 +0200469The tests are incomplete, as is customary. Use the --test flag to run them,
470and make sure you are in the tools/patman directory first:
Simon Glass0d24de92012-01-14 15:12:45 +0000471
472 $ cd /path/to/u-boot
Gerhard Sittigc8605bb2013-07-14 11:27:45 +0200473 $ cd tools/patman
474 $ ./patman --test
Simon Glass0d24de92012-01-14 15:12:45 +0000475
476Error handling doesn't always produce friendly error messages - e.g.
477putting an incorrect tag in a commit may provide a confusing message.
478
479There might be a few other features not mentioned in this README. They
480might be bugs. In particular, tags are case sensitive which is probably
481a bad thing.
482
483
484Simon Glass <sjg@chromium.org>
485v1, v2, 19-Oct-11
486revised v3 24-Nov-11