002ec8f1c6
Add a documentation file (Documentation/nvme/nvme-pci-endpoint-target.rst) for the new NVMe PCI endpoint target driver. This provides an overview of the driver requirements, capabilities and limitations. A user guide describing how to setup a NVMe PCI endpoint device using this driver is also provided. This document is made accessible also from the PCI endpoint documentation using a link. Furthermore, since the existing nvme documentation was not accessible from the top documentation index, an index file is added to Documentation/nvme and this index listed as "NVMe Subsystem" in the "Storage interfaces" section of the subsystem API index. Signed-off-by: Damien Le Moal <dlemoal@kernel.org> Reviewed-by: Christoph Hellwig <hch@lst.de> Acked-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org> Signed-off-by: Keith Busch <kbusch@kernel.org>
92 lines
1.5 KiB
ReStructuredText
92 lines
1.5 KiB
ReStructuredText
.. 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).
|
|
|
|
Core subsystems
|
|
---------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
core-api/index
|
|
driver-api/index
|
|
mm/index
|
|
power/index
|
|
scheduler/index
|
|
timers/index
|
|
locking/index
|
|
|
|
Human interfaces
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
input/index
|
|
hid/index
|
|
sound/index
|
|
gpu/index
|
|
fb/index
|
|
leds/index
|
|
|
|
Networking interfaces
|
|
---------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
networking/index
|
|
netlabel/index
|
|
infiniband/index
|
|
isdn/index
|
|
mhi/index
|
|
|
|
Storage interfaces
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
filesystems/index
|
|
block/index
|
|
cdrom/index
|
|
scsi/index
|
|
target/index
|
|
nvme/index
|
|
|
|
Other subsystems
|
|
----------------
|
|
**Fixme**: much more organizational work is needed here.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
accounting/index
|
|
cpu-freq/index
|
|
fpga/index
|
|
i2c/index
|
|
iio/index
|
|
pcmcia/index
|
|
spi/index
|
|
w1/index
|
|
watchdog/index
|
|
virt/index
|
|
hwmon/index
|
|
accel/index
|
|
security/index
|
|
crypto/index
|
|
bpf/index
|
|
usb/index
|
|
PCI/index
|
|
misc-devices/index
|
|
peci/index
|
|
wmi/index
|
|
tee/index
|