Skip to content

Commit 1e86466

Browse files
committed
Contributing: add 'Soundness issues and backporting' section
Document it inside the "Submit checklist addendum" since it is something that should generally be considered when submitting (and applying, for maintainers). The addendum is an important part of the "Subsystem Profile documents" (i.e. `P:` entries in `MAINTAINERS`), so it seems a good spot, though we may also add it elsewhere, e.g. in the guidelines. Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 5ab905d commit 1e86466

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/Contributing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,14 @@ The following items apply to every patch in a series. That is, in general, each
114114

115115
- Please run your patch through the `scripts/checkpatch.pl` script. In particular, the `--codespell` option is useful to check patches for typos.
116116

117+
#### Soundness issues and backporting
118+
119+
In general, fixes for Rust soundness issues should be marked for backport, unless there is a reason not to (such as situations where the backport may require a lot of effort but the risk of users hitting UB is low).
120+
121+
For context, while the stable kernel rules mention "theoretical issues" should not be backported (which one could argue Rust soundness issues are if no existing users hit UB), we discussed the topic of Rust soundness issues with the stable team and decided that we would do our best to backport them.
122+
123+
The goal is to help to prevent actual issues for downstream users, distributions and vendors that patch the kernel further or even add completely new code on top, since those modifications could hit UB. In other words, the idea is to maintain the "extra layer" of protection in stable kernels too, as much as reasonably possible.
124+
117125
### Key cycle dates
118126

119127
- Patches can be sent anytime.

0 commit comments

Comments
 (0)