Blame view
tools/patman/README
14.6 KB
0d24de9d5 Add 'patman' patc... |
1 2 |
# Copyright (c) 2011 The Chromium OS Authors. # |
1a4596601 Add GPL-2.0+ SPDX... |
3 |
# SPDX-License-Identifier: GPL-2.0+ |
0d24de9d5 Add 'patman' patc... |
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
# What is this? ============= This tool is a Python script which: - Creates patch directly from your branch - Cleans them up by removing unwanted tags - Inserts a cover letter with change lists - Runs the patches through checkpatch.pl and its own checks - Optionally emails them out to selected people It is intended to automate patch creation and make it a less error-prone process. It is useful for U-Boot and Linux work so far, since it uses the checkpatch.pl script. It is configured almost entirely by tags it finds in your commits. This means that you can work on a number of different branches at once, and keep the settings with each branch rather than having to git format-patch, git send-email, etc. with the correct parameters each time. So for example if you put: Series-to: fred.blogs@napier.co.nz in one of your commits, the series will be sent there. |
21a19d70e patman: Add a cal... |
29 30 |
In Linux this will also call get_maintainer.pl on each of your patches automatically. |
0d24de9d5 Add 'patman' patc... |
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
How to use this tool ==================== This tool requires a certain way of working: - Maintain a number of branches, one for each patch series you are working on - Add tags into the commits within each branch to indicate where the series should be sent, cover letter, version, etc. Most of these are normally in the top commit so it is easy to change them with 'git commit --amend' - Each branch tracks the upstream branch, so that this script can automatically determine the number of commits in it (optional) - Check out a branch, and run this script to create and send out your patches. Weeks later, change the patches and repeat, knowing that you will get a consistent result each time. How to configure it =================== |
ca706e768 patman: Minor hel... |
52 |
For most cases of using patman for U-Boot development, patman will |
21a19d70e patman: Add a cal... |
53 54 55 56 57 |
locate and use the file 'doc/git-mailrc' in your U-Boot directory. This contains most of the aliases you will need. For Linux the 'scripts/get_maintainer.pl' handles figuring out where to send patches pretty well. |
0d24de9d5 Add 'patman' patc... |
58 |
|
87d65558e patman: Handle cr... |
59 60 |
During the first run patman creates a config file for you by taking the default user name and email address from the global .gitconfig file. |
2b36c75d7 patman: Change th... |
61 |
To add your own, create a file ~/.patman like this: |
0d24de9d5 Add 'patman' patc... |
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
>>>> # patman alias file [alias] me: Simon Glass <sjg@chromium.org> u-boot: U-Boot Mailing List <u-boot@lists.denx.de> wolfgang: Wolfgang Denk <wd@denx.de> others: Mike Frysinger <vapier@gentoo.org>, Fred Bloggs <f.bloggs@napier.net> <<<< Aliases are recursive. The checkpatch.pl in the U-Boot tools/ subdirectory will be located and used. Failing that you can put it into your path or ~/bin/checkpatch.pl |
8568baed3 patman: Add suppo... |
79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
If you want to change the defaults for patman's command-line arguments, you can add a [settings] section to your .patman file. This can be used for any command line option by referring to the "dest" for the option in patman.py. For reference, the useful ones (at the moment) shown below (all with the non-default setting): >>> [settings] ignore_errors: True process_tags: False verbose: True <<< |
a1dcee84c patman: Add the c... |
93 94 95 96 97 98 99 100 101 102 103 |
If you want to adjust settings (or aliases) that affect just a single project you can add a section that looks like [project_settings] or [project_alias]. If you want to use tags for your linux work, you could do: >>> [linux_settings] process_tags: True <<< |
0d24de9d5 Add 'patman' patc... |
104 105 106 107 |
How to run it ============= First do a dry run: |
330a091c1 patman: Change th... |
108 |
$ ./tools/patman/patman -n |
0d24de9d5 Add 'patman' patc... |
109 110 111 |
If it can't detect the upstream branch, try telling it how many patches there are in your series: |
330a091c1 patman: Change th... |
112 |
$ ./tools/patman/patman -n -c5 |
0d24de9d5 Add 'patman' patc... |
113 114 115 |
This will create patch files in your current directory and tell you who it is thinking of sending them to. Take a look at the patch files. |
330a091c1 patman: Change th... |
116 |
$ ./tools/patman/patman -n -c5 -s1 |
0d24de9d5 Add 'patman' patc... |
117 118 119 120 121 122 123 124 125 126 127 128 |
Similar to the above, but skip the first commit and take the next 5. This is useful if your top commit is for setting up testing. How to add tags =============== To make this script useful you must add tags like the following into any commit. Most can only appear once in the whole series. Series-to: email / alias |
2790bf69d Prepare v2012.04 |
129 130 |
Email address / alias to send patch series to (you can add this multiple times) |
0d24de9d5 Add 'patman' patc... |
131 132 |
Series-cc: email / alias, ... |
2790bf69d Prepare v2012.04 |
133 134 |
Email address / alias to Cc patch series to (you can add this multiple times) |
0d24de9d5 Add 'patman' patc... |
135 136 |
Series-version: n |
2790bf69d Prepare v2012.04 |
137 |
Sets the version number of this patch series |
0d24de9d5 Add 'patman' patc... |
138 139 |
Series-prefix: prefix |
2790bf69d Prepare v2012.04 |
140 141 |
Sets the subject prefix. Normally empty but it can be RFC for RFC patches, or RESEND if you are being ignored. |
0d24de9d5 Add 'patman' patc... |
142 |
|
ef0e9de82 patman: Support S... |
143 144 145 146 |
Series-name: name Sets the name of the series. You don't need to have a name, and patman does not yet use it, but it is convenient to put the branch name here to help you keep track of multiple upstreaming efforts. |
0d24de9d5 Add 'patman' patc... |
147 148 149 150 151 |
Cover-letter: This is the patch set title blah blah more blah blah END |
2790bf69d Prepare v2012.04 |
152 153 |
Sets the cover letter contents for the series. The first line will become the subject of the cover letter |
0d24de9d5 Add 'patman' patc... |
154 |
|
fe2f8d9e2 patman: Add Cover... |
155 156 157 |
Cover-letter-cc: email / alias Additional email addresses / aliases to send cover letter to (you can add this multiple times) |
0d24de9d5 Add 'patman' patc... |
158 159 160 161 162 |
Series-notes: blah blah blah blah more blah blah END |
2790bf69d Prepare v2012.04 |
163 164 165 166 |
Sets some notes for the patch series, which you don't want in the commit messages, but do want to send, The notes are joined together and put after the cover letter. Can appear multiple times. |
0d24de9d5 Add 'patman' patc... |
167 |
|
5c8fdd91d patman: add Commi... |
168 169 170 171 172 173 174 |
Commit-notes: blah blah blah blah more blah blah END Similar, but for a single commit (patch). These notes will appear immediately below the --- cut in the patch file. |
0d24de9d5 Add 'patman' patc... |
175 |
Signed-off-by: Their Name <email> |
2790bf69d Prepare v2012.04 |
176 177 178 |
A sign-off is added automatically to your patches (this is probably a bug). If you put this tag in your patches, it will override the default signoff that patman automatically adds. |
102061bd8 patman: Avoid dup... |
179 |
Multiple duplicate signoffs will be removed. |
0d24de9d5 Add 'patman' patc... |
180 181 |
Tested-by: Their Name <email> |
28b3594eb patman: Make "Rev... |
182 |
Reviewed-by: Their Name <email> |
0d24de9d5 Add 'patman' patc... |
183 |
Acked-by: Their Name <email> |
28b3594eb patman: Make "Rev... |
184 |
These indicate that someone has tested/reviewed/acked your patch. |
2790bf69d Prepare v2012.04 |
185 186 187 188 |
When you get this reply on the mailing list, you can add this tag to the relevant commit and the script will include it when you send out the next version. If 'Tested-by:' is set to yourself, it will be removed. No one will believe you. |
0d24de9d5 Add 'patman' patc... |
189 190 191 192 193 |
Series-changes: n - Guinea pig moved into its cage - Other changes ending with a blank line <blank line> |
2790bf69d Prepare v2012.04 |
194 195 196 197 198 |
This can appear in any commit. It lists the changes for a particular version n of that commit. The change list is created based on this information. Each commit gets its own change list and also the whole thing is repeated in the cover letter (where duplicate change lines are merged). |
0d24de9d5 Add 'patman' patc... |
199 |
|
2790bf69d Prepare v2012.04 |
200 201 202 203 |
By adding your change lists into your commits it is easier to keep track of what happened. When you amend a commit, remember to update the log there and then, knowing that the script will do the rest. |
0d24de9d5 Add 'patman' patc... |
204 |
|
659c89da8 patman: Use Patch... |
205 206 207 208 |
Patch-cc: Their Name <email> This copies a single patch to another email address. Note that the Cc: used by git send-email is ignored by patman, but will be interpreted by git send-email if you use it. |
0d24de9d5 Add 'patman' patc... |
209 |
|
645b271a6 patman: Add Serie... |
210 211 212 213 214 215 |
Series-process-log: sort, uniq This tells patman to sort and/or uniq the change logs. It is assumed that each change log entry is only a single line long. Use 'sort' to sort the entries, and 'uniq' to include only unique entries. If omitted, no change log processing is done. Separate each tag with a comma. |
0d24de9d5 Add 'patman' patc... |
216 217 218 219 220 221 222 223 |
Various other tags are silently removed, like these Chrome OS and Gerrit tags: BUG=... TEST=... Change-Id: Review URL: Reviewed-on: |
5c8fdd91d patman: add Commi... |
224 |
Commit-xxxx: (except Commit-notes) |
0d24de9d5 Add 'patman' patc... |
225 226 227 228 229 230 231 |
Exercise for the reader: Try adding some tags to one of your current patch series and see how the patches turn out. Where Patches Are Sent ====================== |
1713247ff patman: Fix a typ... |
232 |
Once the patches are created, patman sends them using git send-email. The |
0d24de9d5 Add 'patman' patc... |
233 |
whole series is sent to the recipients in Series-to: and Series-cc. |
659c89da8 patman: Use Patch... |
234 235 236 |
You can Cc individual patches to other people with the Patch-cc: tag. Tags in the subject are also picked up to Cc patches. For example, a commit like this: |
0d24de9d5 Add 'patman' patc... |
237 238 239 240 |
>>>> commit 10212537b85ff9b6e09c82045127522c0f0db981 Author: Mike Frysinger <vapier@gentoo.org> |
2790bf69d Prepare v2012.04 |
241 |
Date: Mon Nov 7 23:18:44 2011 -0500 |
0d24de9d5 Add 'patman' patc... |
242 243 244 245 |
x86: arm: add a git mailrc file for maintainers This should make sending out e-mails to the right people easier. |
659c89da8 patman: Use Patch... |
246 247 |
Patch-cc: sandbox, mikef, ag Patch-cc: afleming |
0d24de9d5 Add 'patman' patc... |
248 249 250 251 |
<<<< will create a patch which is copied to x86, arm, sandbox, mikef, ag and afleming. |
659c89da8 patman: Use Patch... |
252 253 254 |
If you have a cover letter it will get sent to the union of the Patch-cc lists of all of the other patches. If you want to sent it to additional people you can add a tag: |
fe2f8d9e2 patman: Add Cover... |
255 256 257 258 259 |
Cover-letter-cc: <list of addresses> These people will get the cover letter even if they are not on the To/Cc list for any of the patches. |
311872551 patman: Add all C... |
260 |
|
0d24de9d5 Add 'patman' patc... |
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
Example Work Flow ================= The basic workflow is to create your commits, add some tags to the top commit, and type 'patman' to check and send them. Here is an example workflow for a series of 4 patches. Let's say you have these rather contrived patches in the following order in branch us-cmd in your tree where 'us' means your upstreaming activity (newest to oldest as output by git log --oneline): 7c7909c wip 89234f5 Don't include standard parser if hush is used 8d640a7 mmc: sparc: Stop using builtin_run_command() 0c859a9 Rename run_command2() to run_command() a74443f sandbox: Rename run_command() to builtin_run_command() The first patch is some test things that enable your code to be compiled, but that you don't want to submit because there is an existing patch for it on the list. So you can tell patman to create and check some patches (skipping the first patch) with: patman -s1 -n If you want to do all of them including the work-in-progress one, then (if you are tracking an upstream branch): patman -n Let's say that patman reports an error in the second patch. Then: git rebase -i HEAD~6 <change 'pick' to 'edit' in 89234f5> <use editor to make code changes> git add -u git rebase --continue Now you have an updated patch series. To check it: patman -s1 -n Let's say it is now clean and you want to send it. Now you need to set up the destination. So amend the top commit with: git commit --amend Use your editor to add some tags, so that the whole commit message is: The current run_command() is really only one of the options, with hush providing the other. It really shouldn't be called directly in case the hush parser is bring used, so rename this function to better explain its purpose. Series-to: u-boot Series-cc: bfin, marex Series-prefix: RFC Cover-letter: Unified command execution in one place At present two parsers have similar code to execute commands. Also cmd_usage() is called all over the place. This series adds a single function which processes commands called cmd_process(). END Change-Id: Ica71a14c1f0ecb5650f771a32fecb8d2eb9d8a17 You want this to be an RFC and Cc the whole series to the bfin alias and to Marek. Two of the patches have tags (those are the bits at the front of the subject that say mmc: sparc: and sandbox:), so 8d640a7 will be Cc'd to mmc and sparc, and the last one to sandbox. Now to send the patches, take off the -n flag: patman -s1 The patches will be created, shown in your editor, and then sent along with the cover letter. Note that patman's tags are automatically removed so that people on the list don't see your secret info. Of course patches often attract comments and you need to make some updates. Let's say one person sent comments and you get an Acked-by: on one patch. Also, the patch on the list that you were waiting for has been merged, so you can drop your wip commit. So you resync with upstream: |
2790bf69d Prepare v2012.04 |
346 |
git fetch origin (or whatever upstream is called) |
0d24de9d5 Add 'patman' patc... |
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
git rebase origin/master and use git rebase -i to edit the commits, dropping the wip one. You add the ack tag to one commit: Acked-by: Heiko Schocher <hs@denx.de> update the Series-cc: in the top commit: Series-cc: bfin, marex, Heiko Schocher <hs@denx.de> and remove the Series-prefix: tag since it it isn't an RFC any more. The series is now version two, so the series info in the top commit looks like this: Series-to: u-boot Series-cc: bfin, marex, Heiko Schocher <hs@denx.de> Series-version: 2 Cover-letter: ... Finally, you need to add a change log to the two commits you changed. You add change logs to each individual commit where the changes happened, like this: Series-changes: 2 - Updated the command decoder to reduce code size - Wound the torque propounder up a little more (note the blank line at the end of the list) When you run patman it will collect all the change logs from the different commits and combine them into the cover letter, if you have one. So finally you have a new series of commits: faeb973 Don't include standard parser if hush is used 1b2f2fe mmc: sparc: Stop using builtin_run_command() cfbe330 Rename run_command2() to run_command() 0682677 sandbox: Rename run_command() to builtin_run_command() so to send them: patman and it will create and send the version 2 series. General points: 1. When you change back to the us-cmd branch days or weeks later all your information is still there, safely stored in the commits. You don't need to remember what version you are up to, who you sent the last lot of patches to, or anything about the change logs. 2. If you put tags in the subject, patman will Cc the maintainers automatically in many cases. 3. If you want to keep the commits from each series you sent so that you can compare change and see what you did, you can either create a new branch for each version, or just tag the branch before you start changing it: git tag sent/us-cmd-rfc ...later... git tag sent/us-cmd-v2 4. If you want to modify the patches a little before sending, you can do this in your editor, but be careful! 5. If you want to run git send-email yourself, use the -n flag which will print out the command line patman would have used. 6. It is a good idea to add the change log info as you change the commit, not later when you can't remember which patch you changed. You can always go back and change or remove logs from commits. Other thoughts ============== This script has been split into sensible files but still needs work. Most of these are indicated by a TODO in the code. It would be nice if this could handle the In-reply-to side of things. |
c8605bb4d patman: README do... |
429 430 |
The tests are incomplete, as is customary. Use the --test flag to run them, and make sure you are in the tools/patman directory first: |
0d24de9d5 Add 'patman' patc... |
431 432 |
$ cd /path/to/u-boot |
c8605bb4d patman: README do... |
433 434 |
$ cd tools/patman $ ./patman --test |
0d24de9d5 Add 'patman' patc... |
435 436 437 438 439 440 441 442 443 444 445 446 |
Error handling doesn't always produce friendly error messages - e.g. putting an incorrect tag in a commit may provide a confusing message. There might be a few other features not mentioned in this README. They might be bugs. In particular, tags are case sensitive which is probably a bad thing. Simon Glass <sjg@chromium.org> v1, v2, 19-Oct-11 revised v3 24-Nov-11 |