diff options
Diffstat (limited to 'Documentation/index.rst')
| -rw-r--r-- | Documentation/index.rst | 205 |
1 files changed, 69 insertions, 136 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index 71eca3171574..c0cf79a87c3a 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,13 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0 - -.. The Linux Kernel documentation master file, created by - sphinx-quickstart on Fri Feb 12 13:51:46 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - .. _linux_doc: +============================== The Linux Kernel documentation ============================== @@ -18,177 +13,115 @@ 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. -Licensing documentation ------------------------ +Working with the development community +====================================== -The following describes the license of the Linux kernel source code -(GPLv2), how to properly mark the license of individual files in the source -tree, as well as links to the full license text. +The essential guides for interacting with the kernel's development +community and getting your work upstream. -* :ref:`kernel_licensing` +.. toctree:: + :maxdepth: 1 -User-oriented documentation ---------------------------- + 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> -The following manuals are written for *users* of the kernel — those who are -trying to get it to work optimally on a given system. -.. toctree:: - :maxdepth: 2 +Internal API manuals +==================== - admin-guide/index - kbuild/index - -Firmware-related documentation ------------------------------- -The following holds information on the kernel's expectations regarding the -platform firmwares. +Manuals for use by developers working to interface with the rest of the +kernel. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - firmware-guide/index - devicetree/index + Core API <core-api/index> + Driver APIs <driver-api/index> + Subsystems <subsystem-apis> + Locking <locking/index> -Application-developer documentation ------------------------------------ +Development tools and processes +=============================== -The user-space API manual gathers together documents describing aspects of -the kernel interface as seen by application developers. +Various other manuals with useful information for all kernel developers. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - userspace-api/index + 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> -Introduction to kernel development ----------------------------------- +User-oriented documentation +=========================== -These manuals contain overall information about how to develop the kernel. -The kernel community is quite large, with thousands of developers -contributing over the course of a year. As with any large community, -knowing how things are done will make the process of getting your changes -merged much easier. +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: 2 - - process/index - dev-tools/index - doc-guide/index - kernel-hacking/index - trace/index - maintainer/index - fault-injection/index - livepatch/index + :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> -Kernel API documentation ------------------------- +See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_, +which are kept separately from the kernel's own documentation. -These books get into the details of how specific kernel subsystems work -from the point of view of a kernel developer. Much of the information here -is taken directly from the kernel source, with supplemental material added -as needed (or at least as we managed to add it — probably *not* all that is -needed). +Firmware-related documentation +============================== +The following holds information on the kernel's expectations regarding the +platform firmware. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - driver-api/index - core-api/index - locking/index - accounting/index - block/index - cdrom/index - cpu-freq/index - ide/index - fb/index - fpga/index - hid/index - i2c/index - iio/index - isdn/index - infiniband/index - leds/index - netlabel/index - networking/index - pcmcia/index - power/index - target/index - timers/index - spi/index - w1/index - watchdog/index - virt/index - input/index - hwmon/index - gpu/index - security/index - sound/index - crypto/index - filesystems/index - vm/index - bpf/index - usb/index - PCI/index - scsi/index - misc-devices/index - scheduler/index - mhi/index - -Architecture-agnostic documentation ------------------------------------ + Firmware <firmware-guide/index> + Firmware and Devicetree <devicetree/index> -.. toctree:: - :maxdepth: 2 - - asm-annotations Architecture-specific documentation ------------------------------------ - -These books provide programming details about architecture-specific -implementation. +=================================== .. toctree:: :maxdepth: 2 - arm/index - arm64/index - ia64/index - m68k/index - mips/index - nios2/nios2 - openrisc/index - parisc/index - powerpc/index - riscv/index - s390/index - sh/index - sparc/index - x86/index - xtensa/index - -Filesystem Documentation ------------------------- - -The documentation in this section are provided by specific filesystem -subprojects. + 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 reStructuredText format, or are simply too old. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + + Unsorted documentation <staging/index> - filesystems/ext4/index Translations ------------- +============ .. toctree:: :maxdepth: 2 - translations/index + Translations <translations/index> Indices and tables ================== |