Skip to content

Commit 0e194d9

Browse files
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]>
1 parent 2f3035d commit 0e194d9

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

Documentation/process/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ lack of a better place.
6060
volatile-considered-harmful
6161
botching-up-ioctls
6262
clang-format
63+
../riscv/patch-acceptance
6364

6465
.. only:: subproject and html
6566

Documentation/riscv/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ RISC-V architecture
77

88
boot-image-header
99
pmu
10+
patch-acceptance
1011

1112
.. only:: subproject and html
1213

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
arch/riscv maintenance guidelines for developers
4+
================================================
5+
6+
Overview
7+
--------
8+
The RISC-V instruction set architecture is developed in the open:
9+
in-progress drafts are available for all to review and to experiment
10+
with implementations. New module or extension drafts can change
11+
during the development process - sometimes in ways that are
12+
incompatible with previous drafts. This flexibility can present a
13+
challenge for RISC-V Linux maintenance. Linux maintainers disapprove
14+
of churn, and the Linux development process prefers well-reviewed and
15+
tested code over experimental code. We wish to extend these same
16+
principles to the RISC-V-related code that will be accepted for
17+
inclusion in the kernel.
18+
19+
Submit Checklist Addendum
20+
-------------------------
21+
We'll only accept patches for new modules or extensions if the
22+
specifications for those modules or extensions are listed as being
23+
"Frozen" or "Ratified" by the RISC-V Foundation. (Developers may, of
24+
course, maintain their own Linux kernel trees that contain code for
25+
any draft extensions that they wish.)
26+
27+
Additionally, the RISC-V specification allows implementors to create
28+
their own custom extensions. These custom extensions aren't required
29+
to go through any review or ratification process by the RISC-V
30+
Foundation. To avoid the maintenance complexity and potential
31+
performance impact of adding kernel code for implementor-specific
32+
RISC-V extensions, we'll only to accept patches for extensions that
33+
have been officially frozen or ratified by the RISC-V Foundation.
34+
(Implementors, may, of course, maintain their own Linux kernel trees
35+
containing code for any custom extensions that they wish.)

MAINTAINERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14119,6 +14119,7 @@ M: Paul Walmsley <[email protected]>
1411914119
M: Palmer Dabbelt <[email protected]>
1412014120
M: Albert Ou <[email protected]>
1412114121
14122+
P: Documentation/riscv/patch-acceptance.rst
1412214123
T: git git://git.kernel.org/pub/scm/linux/kernel/git/riscv/linux.git
1412314124
S: Supported
1412414125
F: arch/riscv/

0 commit comments

Comments
 (0)