0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003
0004 .. The Linux Kernel documentation master file, created by
0005 sphinx-quickstart on Fri Feb 12 13:51:46 2016.
0006 You can adapt this file completely to your liking, but it should at least
0007 contain the root `toctree` directive.
0008
0009 .. _linux_doc:
0010
0011 The Linux Kernel documentation
0012 ==============================
0013
0014 This is the top level of the kernel's documentation tree. Kernel
0015 documentation, like the kernel itself, is very much a work in progress;
0016 that is especially true as we work to integrate our many scattered
0017 documents into a coherent whole. Please note that improvements to the
0018 documentation are welcome; join the linux-doc list at vger.kernel.org if
0019 you want to help out.
0020
0021 Licensing documentation
0022 -----------------------
0023
0024 The following describes the license of the Linux kernel source code
0025 (GPLv2), how to properly mark the license of individual files in the source
0026 tree, as well as links to the full license text.
0027
0028 * :ref:`kernel_licensing`
0029
0030 User-oriented documentation
0031 ---------------------------
0032
0033 The following manuals are written for *users* of the kernel — those who are
0034 trying to get it to work optimally on a given system.
0035
0036 .. toctree::
0037 :maxdepth: 2
0038
0039 admin-guide/index
0040 kbuild/index
0041
0042 Firmware-related documentation
0043 ------------------------------
0044 The following holds information on the kernel's expectations regarding the
0045 platform firmwares.
0046
0047 .. toctree::
0048 :maxdepth: 2
0049
0050 firmware-guide/index
0051 devicetree/index
0052
0053 Application-developer documentation
0054 -----------------------------------
0055
0056 The user-space API manual gathers together documents describing aspects of
0057 the kernel interface as seen by application developers.
0058
0059 .. toctree::
0060 :maxdepth: 2
0061
0062 userspace-api/index
0063
0064
0065 Introduction to kernel development
0066 ----------------------------------
0067
0068 These manuals contain overall information about how to develop the kernel.
0069 The kernel community is quite large, with thousands of developers
0070 contributing over the course of a year. As with any large community,
0071 knowing how things are done will make the process of getting your changes
0072 merged much easier.
0073
0074 .. toctree::
0075 :maxdepth: 2
0076
0077 process/index
0078 dev-tools/index
0079 doc-guide/index
0080 kernel-hacking/index
0081 trace/index
0082 maintainer/index
0083 fault-injection/index
0084 livepatch/index
0085
0086
0087 Kernel API documentation
0088 ------------------------
0089
0090 These books get into the details of how specific kernel subsystems work
0091 from the point of view of a kernel developer. Much of the information here
0092 is taken directly from the kernel source, with supplemental material added
0093 as needed (or at least as we managed to add it — probably *not* all that is
0094 needed).
0095
0096 .. toctree::
0097 :maxdepth: 2
0098
0099 driver-api/index
0100 core-api/index
0101 locking/index
0102 accounting/index
0103 block/index
0104 cdrom/index
0105 cpu-freq/index
0106 fb/index
0107 fpga/index
0108 hid/index
0109 i2c/index
0110 iio/index
0111 isdn/index
0112 infiniband/index
0113 leds/index
0114 netlabel/index
0115 networking/index
0116 pcmcia/index
0117 power/index
0118 target/index
0119 timers/index
0120 spi/index
0121 w1/index
0122 watchdog/index
0123 virt/index
0124 input/index
0125 hwmon/index
0126 gpu/index
0127 security/index
0128 sound/index
0129 crypto/index
0130 filesystems/index
0131 mm/index
0132 bpf/index
0133 usb/index
0134 PCI/index
0135 scsi/index
0136 misc-devices/index
0137 scheduler/index
0138 mhi/index
0139 peci/index
0140
0141 Architecture-agnostic documentation
0142 -----------------------------------
0143
0144 .. toctree::
0145 :maxdepth: 2
0146
0147 asm-annotations
0148
0149 Architecture-specific documentation
0150 -----------------------------------
0151
0152 .. toctree::
0153 :maxdepth: 2
0154
0155 arch
0156
0157
0158 Other documentation
0159 -------------------
0160
0161 There are several unsorted documents that don't seem to fit on other parts
0162 of the documentation body, or may require some adjustments and/or conversion
0163 to ReStructured Text format, or are simply too old.
0164
0165 .. toctree::
0166 :maxdepth: 2
0167
0168 tools/index
0169 staging/index
0170
0171
0172 Translations
0173 ------------
0174
0175 .. toctree::
0176 :maxdepth: 2
0177
0178 translations/index
0179
0180 Indices and tables
0181 ==================
0182
0183 * :ref:`genindex`
