From: Thomas Gleixner <tglx@xxxxxxxxxxxxx> General rules for patch submission, coding style and related details are available, but most subsystems have their subsystem-specific extra rules which differ or go beyond the common rules. Mark suggested to add a subsystem/maintainer handbook section, where subsystem maintainers can explain their specific quirks. Add the section and link to it from the submitting-patches document. [ bp: Add a SPDX identifier. ] Suggested-by: Mark Brown <broonie@xxxxxxxxxx> Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx> Signed-off-by: Borislav Petkov <bp@xxxxxxx> Link: https://lkml.kernel.org/r/20181107171149.074948887@xxxxxxxxxxxxx --- Documentation/process/index.rst | 1 + Documentation/process/maintainer-handbooks.rst | 16 ++++++++++++++++ Documentation/process/submitting-patches.rst | 4 ++++ 3 files changed, 21 insertions(+) create mode 100644 Documentation/process/maintainer-handbooks.rst diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst index dd231ffc8422..9f1b88492bb3 100644 --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@ -27,6 +27,7 @@ Below are the essential guides that every developer should read. submitting-patches programming-language coding-style + maintainer-handbooks maintainer-pgp-guide email-clients kernel-enforcement-statement diff --git a/Documentation/process/maintainer-handbooks.rst b/Documentation/process/maintainer-handbooks.rst new file mode 100644 index 000000000000..cd707727dc8f --- /dev/null +++ b/Documentation/process/maintainer-handbooks.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. _maintainer_handbooks_main: + +Subsystem and maintainer tree specific development process notes +================================================================ + +The purpose of this document is to provide subsystem specific information +which is supplementary to the general development process handbook +:ref:`Documentation/process <development_process_main>`. + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 2 diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index 8ad6b93f91e6..f5ae1efd8cb6 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -21,6 +21,10 @@ If you're unfamiliar with ``git``, you would be well-advised to learn how to use it, it will make your life as a kernel developer and in general much easier. +Some subsystems and maintainer trees have additional information about +their workflow and expectations, see :ref:`Documentation/process/maintainer +handbooks <maintainer_handbooks_main>`. + Obtain a current source tree ---------------------------- -- 2.29.2
