Skip to content

Commit

Permalink
Contributing: clarify what the exceptions are intended to cover
Browse files Browse the repository at this point in the history
In a recent discussion around a networking submission, it was
pointed out that "exceptions" could be more specific [1]. In other
words, the "to simplify the upstreaming process" wording in
the webpage may not be sufficient.

Thus clarify it further with similar notes/examples as those given
in the Zulip discussion.

In addition, link to the recently added "Out-of-tree modules" page
for further details on those.

Link: https://rust-for-linux.zulipchat.com/#narrow/stream/396592-Networking/topic/NAPI.20Abstractions/near/386129495 [1]
Signed-off-by: Miguel Ojeda <[email protected]>
  • Loading branch information
ojeda committed Sep 23, 2023
1 parent 6027745 commit cc563a1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ For new abstractions and modules, and especially for those that require new kern

This way, you can get early design feedback before the actual patch submission later, and the discussion is focused on the given subsystem (rather than the prerequisites).

- In general, the kernel does not allow to integrate code without users, but exceptions can potentially be made for Rust code to simplify the upstreaming process early on. Please contact the Rust maintainers for help, especially if you find yourself with a lot of dependencies or patches for unrelated subsystems.
- In general, the kernel does not allow to integrate code without users, but exceptions can potentially be made for Rust code to simplify the upstreaming process early on. That is, upstreaming some dependencies first so that it is easier to upstream expected in-tree users later on. However, note that this is not meant to be a way to justify upstreaming APIs that do not have agreed upon in-tree users. In particular, [out-of-tree modules](Out-of-tree-modules.md) do not constitute a user in this context.

Please contact the Rust maintainers for help, especially if you find yourself with a lot of dependencies or patches for unrelated subsystems.

## Submitting patches

Expand Down

0 comments on commit cc563a1

Please sign in to comment.