9799445af1
The documentation and TOCs are organized in a manner of a tree. Adding a TOC to the root, which refers to a file which is located in a subfolder forms a grid. Those TOCs are a bit confusing and thats why we get additional error messages while building partial documentation:: $ make SPHINXDIRS=process htmldocs ... checking consistency... Documentation/process/license-rules.rst: \ WARNING: document isn't included in any toctree To fix it, the *root-license-TOC* is replaced by a reference and the 'license-roles.txt' is added to the Documentation/process/index.rst TOC. BTW: there was an old licences remark in Documentation/process/howto.rst which is also updated, mentioning SPDX and pointing to the license-rules.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
64 lines
1.3 KiB
ReStructuredText
64 lines
1.3 KiB
ReStructuredText
.. raw:: latex
|
|
|
|
\renewcommand\thesection*
|
|
\renewcommand\thesubsection*
|
|
|
|
.. _process_index:
|
|
|
|
Working with the kernel development community
|
|
=============================================
|
|
|
|
So you want to be a Linux kernel developer? Welcome! While there is a lot
|
|
to be learned about the kernel in a technical sense, it is also important
|
|
to learn about how our community works. Reading these documents will make
|
|
it much easier for you to get your changes merged with a minimum of
|
|
trouble.
|
|
|
|
Below are the essential guides that every developer should read.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
license-rules
|
|
howto
|
|
code-of-conflict
|
|
development-process
|
|
submitting-patches
|
|
coding-style
|
|
maintainer-pgp-guide
|
|
email-clients
|
|
kernel-enforcement-statement
|
|
kernel-driver-statement
|
|
|
|
Other guides to the community that are of interest to most developers are:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
changes
|
|
submitting-drivers
|
|
stable-api-nonsense
|
|
management-style
|
|
stable-kernel-rules
|
|
submit-checklist
|
|
kernel-docs
|
|
|
|
These are some overall technical guides that have been put here for now for
|
|
lack of a better place.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
applying-patches
|
|
adding-syscalls
|
|
magic-number
|
|
volatile-considered-harmful
|
|
clang-format
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|