mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-03-22 07:27:12 +08:00
a592a36e49
The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
113 lines
2.5 KiB
ReStructuredText
113 lines
2.5 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.
|
|
|
|
An introduction to how kernel development works
|
|
-----------------------------------------------
|
|
|
|
Read these documents first: an understanding of the material here will ease
|
|
your entry into the kernel community.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
howto
|
|
development-process
|
|
submitting-patches
|
|
submit-checklist
|
|
|
|
Tools and technical guides for kernel developers
|
|
------------------------------------------------
|
|
|
|
This is a collection of material that kernel developers should be familiar
|
|
with.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
changes
|
|
programming-language
|
|
coding-style
|
|
maintainer-pgp-guide
|
|
email-clients
|
|
applying-patches
|
|
backporting
|
|
adding-syscalls
|
|
volatile-considered-harmful
|
|
botching-up-ioctls
|
|
|
|
Policy guides and developer statements
|
|
--------------------------------------
|
|
|
|
These are the rules that we try to live by in the kernel community (and
|
|
beyond).
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
license-rules
|
|
code-of-conduct
|
|
code-of-conduct-interpretation
|
|
contribution-maturity-model
|
|
kernel-enforcement-statement
|
|
kernel-driver-statement
|
|
stable-api-nonsense
|
|
stable-kernel-rules
|
|
management-style
|
|
researcher-guidelines
|
|
generated-content
|
|
coding-assistants
|
|
|
|
Dealing with bugs
|
|
-----------------
|
|
|
|
Bugs are a fact of life; it is important that we handle them properly. The
|
|
documents below provide general advice about debugging and describe our
|
|
policies around the handling of a couple of special classes of bugs:
|
|
regressions and security problems.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
debugging/index
|
|
handling-regressions
|
|
security-bugs
|
|
cve
|
|
embargoed-hardware-issues
|
|
|
|
Maintainer information
|
|
----------------------
|
|
|
|
How to find the people who will accept your patches.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
maintainer-handbooks
|
|
maintainers
|
|
|
|
Other material
|
|
--------------
|
|
|
|
Here are some other guides to the community that are of interest to most
|
|
developers:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
kernel-docs
|
|
deprecated
|