linux/Documentation/process/maintainer-handbooks.rst

.. 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

   maintainer-tip
Documentation/process: Add maintainer handbooks section 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@kernel.org> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Borislav Petkov <bp@suse.de> Link: https://lkml.kernel.org/r/20181107171149.074948887@linutronix.de Link: https://lore.kernel.org/r/20210913153942.15251-2-bp@alien8.de Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2021-09-13 18:39:41 +03:00			`.. 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`
Documentation/process: Add tip tree handbook Add a document to the subsystem/maintainer handbook section, which explains what the tip tree is, how it operates and what rules and expectations it has. [ bp: - Add a SPDX identifier, work in most comments from the thread. - 9bf19b78a203 ("Documentation/submitting-patches: Document the SoB chain") is also in the main Documentation but I'm leaving the paragraph here because it has the proper structure - text talks about SoBs and referencing somewhere else would interrupt the flow. - Move backtraces in changelogs to main submitting-patches.rst. - "Patch version information" is explained to a great detail in submitting-patches.rst too. - Hyperlink resend reminders section. ] Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Borislav Petkov <bp@suse.de> Reviewed-by: Paul E. McKenney <paulmck@linux.ibm.com> Link: https://lkml.kernel.org/r/20181107171149.165693799@linutronix.de Link: https://lore.kernel.org/r/20210913153942.15251-3-bp@alien8.de Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2021-09-13 18:39:42 +03:00
			`maintainer-tip`