1 # Copyright (c) 2011 The Chromium OS Authors.
3 # See file CREDITS for list of people who contributed to this
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; either version 2 of
9 # the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 This tool is a Python script which:
26 - Creates patch directly from your branch
27 - Cleans them up by removing unwanted tags
28 - Inserts a cover letter with change lists
29 - Runs the patches through checkpatch.pl and its own checks
30 - Optionally emails them out to selected people
32 It is intended to automate patch creation and make it a less
33 error-prone process. It is useful for U-Boot and Linux work so far,
34 since it uses the checkpatch.pl script.
36 It is configured almost entirely by tags it finds in your commits.
37 This means that you can work on a number of different branches at
38 once, and keep the settings with each branch rather than having to
39 git format-patch, git send-email, etc. with the correct parameters
40 each time. So for example if you put:
42 Series-to: fred.blogs@napier.co.nz
44 in one of your commits, the series will be sent there.
46 In Linux this will also call get_maintainer.pl on each of your
47 patches automatically.
53 This tool requires a certain way of working:
55 - Maintain a number of branches, one for each patch series you are
57 - Add tags into the commits within each branch to indicate where the
58 series should be sent, cover letter, version, etc. Most of these are
59 normally in the top commit so it is easy to change them with 'git
61 - Each branch tracks the upstream branch, so that this script can
62 automatically determine the number of commits in it (optional)
63 - Check out a branch, and run this script to create and send out your
64 patches. Weeks later, change the patches and repeat, knowing that you
65 will get a consistent result each time.
71 For most cases of using patman for U-Boot development, patman will
72 locate and use the file 'doc/git-mailrc' in your U-Boot directory.
73 This contains most of the aliases you will need.
75 For Linux the 'scripts/get_maintainer.pl' handles figuring out where
76 to send patches pretty well.
78 During the first run patman creates a config file for you by taking the default
79 user name and email address from the global .gitconfig file.
81 To add your own, create a file ~/.patman like this:
87 me: Simon Glass <sjg@chromium.org>
89 u-boot: U-Boot Mailing List <u-boot@lists.denx.de>
90 wolfgang: Wolfgang Denk <wd@denx.de>
91 others: Mike Frysinger <vapier@gentoo.org>, Fred Bloggs <f.bloggs@napier.net>
95 Aliases are recursive.
97 The checkpatch.pl in the U-Boot tools/ subdirectory will be located and
98 used. Failing that you can put it into your path or ~/bin/checkpatch.pl
101 If you want to change the defaults for patman's command-line arguments,
102 you can add a [settings] section to your .patman file. This can be used
103 for any command line option by referring to the "dest" for the option in
104 patman.py. For reference, the useful ones (at the moment) shown below
105 (all with the non-default setting):
117 If you want to adjust settings (or aliases) that affect just a single
118 project you can add a section that looks like [project_settings] or
119 [project_alias]. If you want to use tags for your linux work, you could
135 $ ./tools/patman/patman -n
137 If it can't detect the upstream branch, try telling it how many patches
138 there are in your series:
140 $ ./tools/patman/patman -n -c5
142 This will create patch files in your current directory and tell you who
143 it is thinking of sending them to. Take a look at the patch files.
145 $ ./tools/patman/patman -n -c5 -s1
147 Similar to the above, but skip the first commit and take the next 5. This
148 is useful if your top commit is for setting up testing.
154 To make this script useful you must add tags like the following into any
155 commit. Most can only appear once in the whole series.
157 Series-to: email / alias
158 Email address / alias to send patch series to (you can add this
161 Series-cc: email / alias, ...
162 Email address / alias to Cc patch series to (you can add this
166 Sets the version number of this patch series
168 Series-prefix: prefix
169 Sets the subject prefix. Normally empty but it can be RFC for
170 RFC patches, or RESEND if you are being ignored.
173 Sets the name of the series. You don't need to have a name, and
174 patman does not yet use it, but it is convenient to put the branch
175 name here to help you keep track of multiple upstreaming efforts.
178 This is the patch set title
182 Sets the cover letter contents for the series. The first line
183 will become the subject of the cover letter
185 Cover-letter-cc: email / alias
186 Additional email addresses / aliases to send cover letter to (you
187 can add this multiple times)
194 Sets some notes for the patch series, which you don't want in
195 the commit messages, but do want to send, The notes are joined
196 together and put after the cover letter. Can appear multiple
199 Signed-off-by: Their Name <email>
200 A sign-off is added automatically to your patches (this is
201 probably a bug). If you put this tag in your patches, it will
202 override the default signoff that patman automatically adds.
204 Tested-by: Their Name <email>
205 Reviewed-by: Their Name <email>
206 Acked-by: Their Name <email>
207 These indicate that someone has tested/reviewed/acked your patch.
208 When you get this reply on the mailing list, you can add this
209 tag to the relevant commit and the script will include it when
210 you send out the next version. If 'Tested-by:' is set to
211 yourself, it will be removed. No one will believe you.
214 - Guinea pig moved into its cage
215 - Other changes ending with a blank line
217 This can appear in any commit. It lists the changes for a
218 particular version n of that commit. The change list is
219 created based on this information. Each commit gets its own
220 change list and also the whole thing is repeated in the cover
221 letter (where duplicate change lines are merged).
223 By adding your change lists into your commits it is easier to
224 keep track of what happened. When you amend a commit, remember
225 to update the log there and then, knowing that the script will
228 Cc: Their Name <email>
229 This copies a single patch to another email address.
231 Various other tags are silently removed, like these Chrome OS and
241 Exercise for the reader: Try adding some tags to one of your current
242 patch series and see how the patches turn out.
245 Where Patches Are Sent
246 ======================
248 Once the patches are created, patman sends them using git send-email. The
249 whole series is sent to the recipients in Series-to: and Series-cc.
250 You can Cc individual patches to other people with the Cc: tag. Tags in the
251 subject are also picked up to Cc patches. For example, a commit like this:
254 commit 10212537b85ff9b6e09c82045127522c0f0db981
255 Author: Mike Frysinger <vapier@gentoo.org>
256 Date: Mon Nov 7 23:18:44 2011 -0500
258 x86: arm: add a git mailrc file for maintainers
260 This should make sending out e-mails to the right people easier.
262 Cc: sandbox, mikef, ag
266 will create a patch which is copied to x86, arm, sandbox, mikef, ag and
269 If you have a cover letter it will get sent to the union of the CC lists of
270 all of the other patches. If you want to sent it to additional people you
273 Cover-letter-cc: <list of addresses>
275 These people will get the cover letter even if they are not on the To/Cc
276 list for any of the patches.
282 The basic workflow is to create your commits, add some tags to the top
283 commit, and type 'patman' to check and send them.
285 Here is an example workflow for a series of 4 patches. Let's say you have
286 these rather contrived patches in the following order in branch us-cmd in
287 your tree where 'us' means your upstreaming activity (newest to oldest as
288 output by git log --oneline):
291 89234f5 Don't include standard parser if hush is used
292 8d640a7 mmc: sparc: Stop using builtin_run_command()
293 0c859a9 Rename run_command2() to run_command()
294 a74443f sandbox: Rename run_command() to builtin_run_command()
296 The first patch is some test things that enable your code to be compiled,
297 but that you don't want to submit because there is an existing patch for it
298 on the list. So you can tell patman to create and check some patches
299 (skipping the first patch) with:
303 If you want to do all of them including the work-in-progress one, then
304 (if you are tracking an upstream branch):
308 Let's say that patman reports an error in the second patch. Then:
311 <change 'pick' to 'edit' in 89234f5>
312 <use editor to make code changes>
314 git rebase --continue
316 Now you have an updated patch series. To check it:
320 Let's say it is now clean and you want to send it. Now you need to set up
321 the destination. So amend the top commit with:
325 Use your editor to add some tags, so that the whole commit message is:
327 The current run_command() is really only one of the options, with
328 hush providing the other. It really shouldn't be called directly
329 in case the hush parser is bring used, so rename this function to
330 better explain its purpose.
333 Series-cc: bfin, marex
336 Unified command execution in one place
338 At present two parsers have similar code to execute commands. Also
339 cmd_usage() is called all over the place. This series adds a single
340 function which processes commands called cmd_process().
343 Change-Id: Ica71a14c1f0ecb5650f771a32fecb8d2eb9d8a17
346 You want this to be an RFC and Cc the whole series to the bfin alias and
347 to Marek. Two of the patches have tags (those are the bits at the front of
348 the subject that say mmc: sparc: and sandbox:), so 8d640a7 will be Cc'd to
349 mmc and sparc, and the last one to sandbox.
351 Now to send the patches, take off the -n flag:
355 The patches will be created, shown in your editor, and then sent along with
356 the cover letter. Note that patman's tags are automatically removed so that
357 people on the list don't see your secret info.
359 Of course patches often attract comments and you need to make some updates.
360 Let's say one person sent comments and you get an Acked-by: on one patch.
361 Also, the patch on the list that you were waiting for has been merged,
362 so you can drop your wip commit. So you resync with upstream:
364 git fetch origin (or whatever upstream is called)
365 git rebase origin/master
367 and use git rebase -i to edit the commits, dropping the wip one. You add
368 the ack tag to one commit:
370 Acked-by: Heiko Schocher <hs@denx.de>
372 update the Series-cc: in the top commit:
374 Series-cc: bfin, marex, Heiko Schocher <hs@denx.de>
376 and remove the Series-prefix: tag since it it isn't an RFC any more. The
377 series is now version two, so the series info in the top commit looks like
381 Series-cc: bfin, marex, Heiko Schocher <hs@denx.de>
386 Finally, you need to add a change log to the two commits you changed. You
387 add change logs to each individual commit where the changes happened, like
391 - Updated the command decoder to reduce code size
392 - Wound the torque propounder up a little more
394 (note the blank line at the end of the list)
396 When you run patman it will collect all the change logs from the different
397 commits and combine them into the cover letter, if you have one. So finally
398 you have a new series of commits:
400 faeb973 Don't include standard parser if hush is used
401 1b2f2fe mmc: sparc: Stop using builtin_run_command()
402 cfbe330 Rename run_command2() to run_command()
403 0682677 sandbox: Rename run_command() to builtin_run_command()
409 and it will create and send the version 2 series.
413 1. When you change back to the us-cmd branch days or weeks later all your
414 information is still there, safely stored in the commits. You don't need
415 to remember what version you are up to, who you sent the last lot of patches
416 to, or anything about the change logs.
418 2. If you put tags in the subject, patman will Cc the maintainers
419 automatically in many cases.
421 3. If you want to keep the commits from each series you sent so that you can
422 compare change and see what you did, you can either create a new branch for
423 each version, or just tag the branch before you start changing it:
425 git tag sent/us-cmd-rfc
427 git tag sent/us-cmd-v2
429 4. If you want to modify the patches a little before sending, you can do
430 this in your editor, but be careful!
432 5. If you want to run git send-email yourself, use the -n flag which will
433 print out the command line patman would have used.
435 6. It is a good idea to add the change log info as you change the commit,
436 not later when you can't remember which patch you changed. You can always
437 go back and change or remove logs from commits.
443 This script has been split into sensible files but still needs work.
444 Most of these are indicated by a TODO in the code.
446 It would be nice if this could handle the In-reply-to side of things.
448 The tests are incomplete, as is customary. Use the -t flag to run them,
449 and make sure you are in the tools/scripts/patman directory first:
452 $ cd tools/scripts/patman
455 Error handling doesn't always produce friendly error messages - e.g.
456 putting an incorrect tag in a commit may provide a confusing message.
458 There might be a few other features not mentioned in this README. They
459 might be bugs. In particular, tags are case sensitive which is probably
463 Simon Glass <sjg@chromium.org>