docs: Apply some basic organization to the process guide
Put like documents together, with the essential ones at the top, and split the TOC into sections. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
5700d19748
commit
9b4ebd98da
|
@ -1,6 +1,6 @@
|
||||||
.. _changes:
|
.. _changes:
|
||||||
|
|
||||||
Minimal requerements to compile the Kernel
|
Minimal requirements to compile the Kernel
|
||||||
++++++++++++++++++++++++++++++++++++++++++
|
++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
Intro
|
Intro
|
||||||
|
|
|
@ -4,29 +4,48 @@
|
||||||
\renewcommand\thesubsection*
|
\renewcommand\thesubsection*
|
||||||
|
|
||||||
|
|
||||||
Linux Kernel Development Documentation
|
Working with the kernel development community
|
||||||
======================================
|
=============================================
|
||||||
|
|
||||||
Contents:
|
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::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
howto
|
howto
|
||||||
changes
|
code-of-conflict
|
||||||
coding-style
|
development-process
|
||||||
submitting-patches
|
submitting-patches
|
||||||
|
coding-style
|
||||||
|
email-clients
|
||||||
|
|
||||||
|
Other guides to the community that are of interest to most developers are:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
changes
|
||||||
submitting-drivers
|
submitting-drivers
|
||||||
stable-api-nonsense
|
stable-api-nonsense
|
||||||
management-style
|
management-style
|
||||||
stable-kernel-rules
|
stable-kernel-rules
|
||||||
kernel-docs
|
|
||||||
applying-patches
|
|
||||||
email-clients
|
|
||||||
submit-checklist
|
submit-checklist
|
||||||
code-of-conflict
|
kernel-docs
|
||||||
|
|
||||||
|
These are some overall technical guides that have been put here for now for
|
||||||
|
lack of a better place.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
applying-patches
|
||||||
adding-syscalls
|
adding-syscalls
|
||||||
magic-number
|
magic-number
|
||||||
volatile-considered-harmful
|
volatile-considered-harmful
|
||||||
|
|
||||||
development-process
|
|
||||||
|
|
Loading…
Reference in New Issue