|
1 | | -List of maintainers and how to submit kernel changes |
2 | | -==================================================== |
3 | | - |
4 | | -Please try to follow the guidelines below. This will make things |
5 | | -easier on the maintainers. Not all of these guidelines matter for every |
6 | | -trivial patch so apply some common sense. |
7 | | - |
8 | | -Tips for patch submitters |
9 | | -------------------------- |
10 | | - |
11 | | -1. Always *test* your changes, however small, on at least 4 or |
12 | | - 5 people, preferably many more. |
13 | | - |
14 | | -2. Try to release a few ALPHA test versions to the net. Announce |
15 | | - them onto the kernel channel and await results. This is especially |
16 | | - important for device drivers, because often that's the only way |
17 | | - you will find things like the fact version 3 firmware needs |
18 | | - a magic fix you didn't know about, or some clown changed the |
19 | | - chips on a board and not its name. (Don't laugh! Look at the |
20 | | - SMC etherpower for that.) |
21 | | - |
22 | | -3. Make sure your changes compile correctly in multiple |
23 | | - configurations. In particular check that changes work both as a |
24 | | - module and built into the kernel. |
25 | | - |
26 | | -4. When you are happy with a change make it generally available for |
27 | | - testing and await feedback. |
28 | | - |
29 | | -5. Make a patch available to the relevant maintainer in the list. Use |
30 | | - ``diff -u`` to make the patch easy to merge. Be prepared to get your |
31 | | - changes sent back with seemingly silly requests about formatting |
32 | | - and variable names. These aren't as silly as they seem. One |
33 | | - job the maintainers (and especially Linus) do is to keep things |
34 | | - looking the same. Sometimes this means that the clever hack in |
35 | | - your driver to get around a problem actually needs to become a |
36 | | - generalized kernel feature ready for next time. |
37 | | - |
38 | | - PLEASE check your patch with the automated style checker |
39 | | - (scripts/checkpatch.pl) to catch trivial style violations. |
40 | | - See Documentation/process/coding-style.rst for guidance here. |
41 | | - |
42 | | - PLEASE CC: the maintainers and mailing lists that are generated |
43 | | - by ``scripts/get_maintainer.pl.`` The results returned by the |
44 | | - script will be best if you have git installed and are making |
45 | | - your changes in a branch derived from Linus' latest git tree. |
46 | | - See Documentation/process/submitting-patches.rst for details. |
47 | | - |
48 | | - PLEASE try to include any credit lines you want added with the |
49 | | - patch. It avoids people being missed off by mistake and makes |
50 | | - it easier to know who wants adding and who doesn't. |
51 | | - |
52 | | - PLEASE document known bugs. If it doesn't work for everything |
53 | | - or does something very odd once a month document it. |
54 | | - |
55 | | - PLEASE remember that submissions must be made under the terms |
56 | | - of the Linux Foundation certificate of contribution and should |
57 | | - include a Signed-off-by: line. The current version of this |
58 | | - "Developer's Certificate of Origin" (DCO) is listed in the file |
59 | | - Documentation/process/submitting-patches.rst. |
60 | | - |
61 | | -6. Make sure you have the right to send any changes you make. If you |
62 | | - do changes at work you may find your employer owns the patch |
63 | | - not you. |
64 | | - |
65 | | -7. When sending security related changes or reports to a maintainer |
66 | | - please Cc: security@kernel.org, especially if the maintainer |
67 | | - does not respond. Please keep in mind that the security team is |
68 | | - a small set of people who can be efficient only when working on |
69 | | - verified bugs. Please only Cc: this list when you have identified |
70 | | - that the bug would present a short-term risk to other users if it |
71 | | - were publicly disclosed. For example, reports of address leaks do |
72 | | - not represent an immediate threat and are better handled publicly, |
73 | | - and ideally, should come with a patch proposal. Please do not send |
74 | | - automated reports to this list either. Such bugs will be handled |
75 | | - better and faster in the usual public places. See |
76 | | - Documentation/process/security-bugs.rst for details. |
77 | | - |
78 | | -8. Happy hacking. |
| 1 | +List of maintainers |
| 2 | +=================== |
79 | 3 |
|
80 | 4 | Descriptions of section entries and preferred order |
81 | 5 | --------------------------------------------------- |
|
0 commit comments