]>
Commit | Line | Data |
---|---|---|
21d6c5d9 MT |
1 | # Maintainer tools |
2 | ||
3 | Useful tools used in daily routines: | |
4 | - [checkpatch](https://docs.kernel.org/dev-tools/checkpatch.html) | |
5 | - [kup](https://korg.docs.kernel.org/kup.html) | |
6 | - [Auto-publishing](https://korg.docs.kernel.org/kup.html#auto-publishing-with-git-archive-signer) | |
7 | - [b4](https://b4.docs.kernel.org/en/latest/) | |
8 | ||
9 | # Checklist before applying patch | |
10 | ||
11 | We don't have CI testing yet, so all those steps must be performed manually: | |
12 | - Style check with [checkpatch](https://docs.kernel.org/dev-tools/checkpatch.html): | |
13 | ||
14 | This is the current code style follows. We are not strict to all rules. It must be run | |
15 | by **checkpatch --no-tree**, see README.md. | |
16 | ||
17 | - [Commit style](https://www.kernel.org/doc/html/v4.10/process/submitting-patches.html): | |
18 | ||
19 | It doesn't need to be followed as strictly as is in kernel but changes should be logically | |
20 | separated. Submitter should care at least to mention "It is used in next patches" if unused | |
21 | externs/files are added in patch. We love: *Reported-by:*, *Suggested-by:*, *Fixes:* tags. | |
22 | ||
23 | - Compilation, ideally on various gcc versions. | |
24 | - Mdadm test suite execution. | |
25 | - Consider requesting new tests from submitter, especially for new functionalities. | |
26 | - Ensure that maintainer *sign-off* is added, before pushing. | |
27 | ||
28 | # Making a release | |
29 | ||
30 | Assuming that maintainer is certain that release is safe, following steps must be done: | |
31 | ||
32 | - Update versions strings in release commit, please refer to previous releases for examples. | |
33 | ||
34 | - Create GPG signed tag and push it to repo. Use same format as was used previously, prefixed by | |
35 | **mdadm-**, e.g. **mdadm-3.1.2**, **mdadm-4.1**. | |
36 | ||
37 | - [Auto-publishing](https://korg.docs.kernel.org/kup.html#auto-publishing-with-git-archive-signer): | |
38 | ||
39 | Adopt script to our release tag model. When ready, push signed note to repository. If it is done | |
40 | correctly, then *(sig)* is added to the package automatically generated by kernel.org automation. | |
41 | There is no need to upload archive manually. | |
42 | ||
43 | - Update CHANGELOG.md. | |
44 | - Write "ANNOUNCE" mail to linux-raid@kernel.org to notify community. |