Blame view
README.md
6.25 KB
f8978f4f6 ANDROID: add READ... |
1 2 3 4 5 |
# How do I submit patches to Android Common Kernels 1. BEST: Make all of your changes to upstream Linux. If appropriate, backport to the stable releases. These patches will be merged automatically in the corresponding common kernels. If the patch is already in upstream Linux, post a backport of the patch that conforms to the patch requirements below. |
2f886a659 ANDROID: README.m... |
6 7 8 9 10 11 |
- Do not send patches upstream that contain only symbol exports. To be considered for upstream Linux, additions of `EXPORT_SYMBOL_GPL()` require an in-tree modular driver that uses the symbol -- so include the new driver or changes to an existing driver in the same patchset as the export. - When sending patches upstream, the commit message must contain a clear case for why the patch is needed and beneficial to the community. Enabling out-of-tree drivers or functionality is not not a persuasive case. |
f8978f4f6 ANDROID: add READ... |
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
2. LESS GOOD: Develop your patches out-of-tree (from an upstream Linux point-of-view). Unless these are fixing an Android-specific bug, these are very unlikely to be accepted unless they have been coordinated with kernel-team@android.com. If you want to proceed, post a patch that conforms to the patch requirements below. # Common Kernel patch requirements - All patches must conform to the Linux kernel coding standards and pass `script/checkpatch.pl` - Patches shall not break gki_defconfig or allmodconfig builds for arm, arm64, x86, x86_64 architectures (see https://source.android.com/setup/build/building-kernels) - If the patch is not merged from an upstream branch, the subject must be tagged with the type of patch: `UPSTREAM:`, `BACKPORT:`, `FROMGIT:`, `FROMLIST:`, or `ANDROID:`. - All patches must have a `Change-Id:` tag (see https://gerrit-review.googlesource.com/Documentation/user-changeid.html) - If an Android bug has been assigned, there must be a `Bug:` tag. - All patches must have a `Signed-off-by:` tag by the author and the submitter Additional requirements are listed below based on patch type ## Requirements for backports from mainline Linux: `UPSTREAM:`, `BACKPORT:` - If the patch is a cherry-pick from Linux mainline with no changes at all - tag the patch subject with `UPSTREAM:`. |
21ec9a7f9 ANDROID: README: ... |
35 |
- add upstream commit information with a `(cherry picked from commit ...)` line |
f8978f4f6 ANDROID: add READ... |
36 37 38 39 40 41 42 43 44 |
- Example: - if the upstream commit message is ``` important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> ``` |
21578d546 ANDROID: README.m... |
45 |
>- then Joe Smith would upload the patch for the common kernel as |
f8978f4f6 ANDROID: add READ... |
46 47 48 49 50 51 52 53 54 |
``` UPSTREAM: important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> Bug: 135791357 Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 |
21ec9a7f9 ANDROID: README: ... |
55 |
(cherry picked from commit c31e73121f4c1ec41143423ac6ce3ce6dafdcec1) |
f8978f4f6 ANDROID: add READ... |
56 57 58 59 60 61 |
Signed-off-by: Joe Smith <joe.smith@foo.org> ``` - If the patch requires any changes from the upstream version, tag the patch with `BACKPORT:` instead of `UPSTREAM:`. - use the same tags as `UPSTREAM:` |
21ec9a7f9 ANDROID: README: ... |
62 |
- add comments about the changes under the `(cherry picked from commit ...)` line |
f8978f4f6 ANDROID: add READ... |
63 64 65 66 67 68 69 70 71 72 |
- Example: ``` BACKPORT: important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> Bug: 135791357 Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 |
21ec9a7f9 ANDROID: README: ... |
73 |
(cherry picked from commit c31e73121f4c1ec41143423ac6ce3ce6dafdcec1) |
cba941a10 ANDROID: README: ... |
74 |
[joe: Resolved minor conflict in drivers/foo/bar.c ] |
f8978f4f6 ANDROID: add READ... |
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
Signed-off-by: Joe Smith <joe.smith@foo.org> ``` ## Requirements for other backports: `FROMGIT:`, `FROMLIST:`, - If the patch has been merged into an upstream maintainer tree, but has not yet been merged into Linux mainline - tag the patch subject with `FROMGIT:` - add info on where the patch came from as `(cherry picked from commit <sha1> <repo> <branch>)`. This must be a stable maintainer branch (not rebased, so don't use `linux-next` for example). - if changes were required, use `BACKPORT: FROMGIT:` - Example: - if the commit message in the maintainer tree is ``` important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> ``` |
21578d546 ANDROID: README.m... |
95 |
>- then Joe Smith would upload the patch for the common kernel as |
f8978f4f6 ANDROID: add READ... |
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
``` FROMGIT: important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> Bug: 135791357 (cherry picked from commit 878a2fd9de10b03d11d2f622250285c7e63deace https://git.kernel.org/pub/scm/linux/kernel/git/foo/bar.git test-branch) Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 Signed-off-by: Joe Smith <joe.smith@foo.org> ``` - If the patch has been submitted to LKML, but not accepted into any maintainer tree - tag the patch subject with `FROMLIST:` |
511b851f8 ANDROID: Fix typo... |
113 |
- add a `Link:` tag with a link to the submittal on lore.kernel.org |
9794e7e47 ANDROID: README: ... |
114 115 |
- add a `Bug:` tag with the Android bug (required for patches not accepted into a maintainer tree) |
f8978f4f6 ANDROID: add READ... |
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
- if changes were required, use `BACKPORT: FROMLIST:` - Example: ``` FROMLIST: important patch from upstream This is the detailed description of the important patch Signed-off-by: Fred Jones <fred.jones@foo.org> Bug: 135791357 Link: https://lore.kernel.org/lkml/20190619171517.GA17557@someone.com/ Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 Signed-off-by: Joe Smith <joe.smith@foo.org> ``` ## Requirements for Android-specific patches: `ANDROID:` - If the patch is fixing a bug to Android-specific code - tag the patch subject with `ANDROID:` - add a `Fixes:` tag that cites the patch with the bug - Example: ``` ANDROID: fix android-specific bug in foobar.c This is the detailed description of the important fix Fixes: 1234abcd2468 ("foobar: add cool feature") Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 Signed-off-by: Joe Smith <joe.smith@foo.org> ``` - If the patch is a new feature - tag the patch subject with `ANDROID:` - add a `Bug:` tag with the Android bug (required for android-specific features) |