diff options
author | Jonathan Corbet <corbet@lwn.net> | 2022-09-27 18:05:54 +0200 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2022-09-29 20:55:06 +0200 |
commit | 0c7b4366f1ab955f0b8411c14e764d75e21e1a1c (patch) | |
tree | 4ef0b89a8df94ec9692741fceb16c5a0dda917ec /Documentation/subsystem-apis.rst | |
parent | docs: promote the title of process/index.rst (diff) | |
download | linux-0c7b4366f1ab955f0b8411c14e764d75e21e1a1c.tar.xz linux-0c7b4366f1ab955f0b8411c14e764d75e21e1a1c.zip |
docs: Rewrite the front page
The front page is the entry point to the documentation, especially for
people who read it online. It's a big mess of everything we could think to
toss into it. Rewrite the page with an eye toward simplicity and making it
easy for readers to get going toward what they really want to find.
This is only a beginning, but it makes our docs more approachable than
before.
Acked-by: Jani Nikula <jani.nikula@intel.com>
Reviewed-by: David Vernet <void@manifault.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-3-corbet@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/subsystem-apis.rst')
-rw-r--r-- | Documentation/subsystem-apis.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst new file mode 100644 index 000000000000..af65004a80aa --- /dev/null +++ b/Documentation/subsystem-apis.rst @@ -0,0 +1,58 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================== +Kernel subsystem 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). + +**Fixme**: much more organizational work is needed here. + +.. toctree:: + :maxdepth: 1 + + driver-api/index + core-api/index + locking/index + accounting/index + block/index + cdrom/index + cpu-freq/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 + mm/index + bpf/index + usb/index + PCI/index + scsi/index + misc-devices/index + scheduler/index + mhi/index + peci/index |