forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation: riscv: add patch acceptance guidelines
Formalize, in kernel documentation, the patch acceptance policy for arch/riscv. In summary, it states that as maintainers, we plan to only accept patches for new modules or extensions that have been frozen or ratified by the RISC-V Foundation. We've been following these guidelines for the past few months. In the meantime, we've received quite a bit of feedback that it would be helpful to have these guidelines formally documented. Based on a suggestion from Matthew Wilcox, we also add a link to this file to Documentation/process/index.rst, to make this document easier to find. The format of this document has also been changed to align to the format outlined in the maintainer entry profiles, in accordance with comments from Jon Corbet and Dan Williams. Signed-off-by: Paul Walmsley <[email protected]> Reviewed-by: Palmer Dabbelt <[email protected]> Cc: Palmer Dabbelt <[email protected]> Cc: Albert Ou <[email protected]> Cc: Krste Asanovic <[email protected]> Cc: Andrew Waterman <[email protected]> Cc: Matthew Wilcox <[email protected]> Cc: Dan Williams <[email protected]> Cc: Jonathan Corbet <[email protected]>
- Loading branch information
1 parent
2f3035d
commit 0e194d9
Showing
4 changed files
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ RISC-V architecture | |
|
||
boot-image-header | ||
pmu | ||
patch-acceptance | ||
|
||
.. only:: subproject and html | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
arch/riscv maintenance guidelines for developers | ||
================================================ | ||
|
||
Overview | ||
-------- | ||
The RISC-V instruction set architecture is developed in the open: | ||
in-progress drafts are available for all to review and to experiment | ||
with implementations. New module or extension drafts can change | ||
during the development process - sometimes in ways that are | ||
incompatible with previous drafts. This flexibility can present a | ||
challenge for RISC-V Linux maintenance. Linux maintainers disapprove | ||
of churn, and the Linux development process prefers well-reviewed and | ||
tested code over experimental code. We wish to extend these same | ||
principles to the RISC-V-related code that will be accepted for | ||
inclusion in the kernel. | ||
|
||
Submit Checklist Addendum | ||
------------------------- | ||
We'll only accept patches for new modules or extensions if the | ||
specifications for those modules or extensions are listed as being | ||
"Frozen" or "Ratified" by the RISC-V Foundation. (Developers may, of | ||
course, maintain their own Linux kernel trees that contain code for | ||
any draft extensions that they wish.) | ||
|
||
Additionally, the RISC-V specification allows implementors to create | ||
their own custom extensions. These custom extensions aren't required | ||
to go through any review or ratification process by the RISC-V | ||
Foundation. To avoid the maintenance complexity and potential | ||
performance impact of adding kernel code for implementor-specific | ||
RISC-V extensions, we'll only to accept patches for extensions that | ||
have been officially frozen or ratified by the RISC-V Foundation. | ||
(Implementors, may, of course, maintain their own Linux kernel trees | ||
containing code for any custom extensions that they wish.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14119,6 +14119,7 @@ M: Paul Walmsley <[email protected]> | |
M: Palmer Dabbelt <[email protected]> | ||
M: Albert Ou <[email protected]> | ||
L: [email protected] | ||
P: Documentation/riscv/patch-acceptance.rst | ||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/riscv/linux.git | ||
S: Supported | ||
F: arch/riscv/ | ||
|