9d2cccdd6c
The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
58 lines
1.2 KiB
ReStructuredText
58 lines
1.2 KiB
ReStructuredText
.. raw:: latex
|
|
|
|
\renewcommand\thesection*
|
|
\renewcommand\thesubsection*
|
|
|
|
|
|
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
|
|
|
|
howto
|
|
code-of-conflict
|
|
development-process
|
|
submitting-patches
|
|
coding-style
|
|
email-clients
|
|
|
|
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
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|