README 21 KB

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