1f44039766
- Some cleanup of the main index page for easier navigation
- Rework some of the other top-level pages for better readability and, with
luck, fewer merge conflicts in the future.
- Submit-checklist improvements, hopefully the first of many.
- New Italian translations
- A fair number of kernel-doc fixes and improvements. We have also dropped
the recommendation to use an old version of Sphinx.
- A new document from Thorsten on bisection
...and lots of fixes and updates.
-----BEGIN PGP SIGNATURE-----
iQEzBAABCAAdFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmXvKVIACgkQF0NaE2wM
flik1gf/ZFS1mHwDdmHA/vpx8UxdUlFEo0Pms8V24iPSW5aEIqkZ406c9DSyMTtp
CXTzW+RSCfB1Q3ciYtakHBgv0RzZ5+RyaEZ1l7zVmMyw4nYvK6giYKmg8Y0EVPKI
fAVuPWo5iE7io0sNVbKBKJJkj9Z8QEScM48hv/CV1FblMvHYn0lie6muJrF9G6Ez
HND+hlYZtWkbRd5M86CDBiFeGMLVPx17T+psQyQIcbUYm9b+RUqZRHIVRLYbad7r
18r9+83DsOhXTVJCBBSfCSZwzF8yAm+eD1w47sxnSItF8OiIjqCzQgXs3BZe9TXH
h2YyeWbMN3xByA4mEgpmOPP44RW7Pg==
=SC60
-----END PGP SIGNATURE-----
Merge tag 'docs-6.9' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet:
"A moderatly busy cycle for development this time around.
- Some cleanup of the main index page for easier navigation
- Rework some of the other top-level pages for better readability
and, with luck, fewer merge conflicts in the future.
- Submit-checklist improvements, hopefully the first of many.
- New Italian translations
- A fair number of kernel-doc fixes and improvements. We have also
dropped the recommendation to use an old version of Sphinx.
- A new document from Thorsten on bisection
... and lots of fixes and updates"
* tag 'docs-6.9' of git://git.lwn.net/linux: (54 commits)
docs: verify/bisect: fixes, finetuning, and support for Arch
docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs
docs: Move ja_JP/howto.rst to ja_JP/process/howto.rst
docs: submit-checklist: use subheadings
docs: submit-checklist: structure by category
docs: new text on bisecting which also covers bug validation
docs: drop the version constraints for sphinx and dependencies
docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4
docs: Restore "smart quotes" for quotes
docs/zh_CN: accurate translation of "function"
docs: Include simplified link titles in main index
docs: Correct formatting of title in admin-guide/index.rst
docs: kernel_feat.py: fix build error for missing files
MAINTAINERS: Set the field name for subsystem profile section
kasan: Add documentation for CONFIG_KASAN_EXTRA_INFO
Fixed case issue with 'fault-injection' in documentation
kernel-doc: handle #if in enums as well
Documentation: update mailing list addresses
doc: kerneldoc.py: fix indentation
scripts/kernel-doc: simplify signature printing
...
130 lines
3.2 KiB
ReStructuredText
130 lines
3.2 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
.. _linux_doc:
|
|
|
|
==============================
|
|
The Linux Kernel documentation
|
|
==============================
|
|
|
|
This is the top level of the kernel's documentation tree. Kernel
|
|
documentation, like the kernel itself, is very much a work in progress;
|
|
that is especially true as we work to integrate our many scattered
|
|
documents into a coherent whole. Please note that improvements to the
|
|
documentation are welcome; join the linux-doc list at vger.kernel.org if
|
|
you want to help out.
|
|
|
|
Working with the development community
|
|
======================================
|
|
|
|
The essential guides for interacting with the kernel's development
|
|
community and getting your work upstream.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Development process <process/development-process>
|
|
Submitting patches <process/submitting-patches>
|
|
Code of conduct <process/code-of-conduct>
|
|
Maintainer handbook <maintainer/index>
|
|
All development-process docs <process/index>
|
|
|
|
|
|
Internal API manuals
|
|
====================
|
|
|
|
Manuals for use by developers working to interface with the rest of the
|
|
kernel.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Core API <core-api/index>
|
|
Driver APIs <driver-api/index>
|
|
Subsystems <subsystem-apis>
|
|
Locking <locking/index>
|
|
|
|
Development tools and processes
|
|
===============================
|
|
|
|
Various other manuals with useful information for all kernel developers.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Licensing rules <process/license-rules>
|
|
Writing documentation <doc-guide/index>
|
|
Development tools <dev-tools/index>
|
|
Testing guide <dev-tools/testing-overview>
|
|
Hacking guide <kernel-hacking/index>
|
|
Tracing <trace/index>
|
|
Fault injection <fault-injection/index>
|
|
Livepatching <livepatch/index>
|
|
Rust <rust/index>
|
|
|
|
|
|
User-oriented documentation
|
|
===========================
|
|
|
|
The following manuals are written for *users* of the kernel — those who are
|
|
trying to get it to work optimally on a given system and application
|
|
developers seeking information on the kernel's user-space APIs.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Administration <admin-guide/index>
|
|
Build system <kbuild/index>
|
|
Reporting issues <admin-guide/reporting-issues.rst>
|
|
Userspace tools <tools/index>
|
|
Userspace API <userspace-api/index>
|
|
|
|
See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
|
|
which are kept separately from the kernel's own documentation.
|
|
|
|
Firmware-related documentation
|
|
==============================
|
|
The following holds information on the kernel's expectations regarding the
|
|
platform firmwares.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Firmware <firmware-guide/index>
|
|
Firmware and Devicetree <devicetree/index>
|
|
|
|
|
|
Architecture-specific documentation
|
|
===================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
CPU architectures <arch/index>
|
|
|
|
|
|
Other documentation
|
|
===================
|
|
|
|
There are several unsorted documents that don't seem to fit on other parts
|
|
of the documentation body, or may require some adjustments and/or conversion
|
|
to ReStructured Text format, or are simply too old.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Unsorted documentation <staging/index>
|
|
|
|
|
|
Translations
|
|
============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Translations <translations/index>
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|