]> www.infradead.org Git - nvme.git/commit
Documentation: Document the NVMe PCI endpoint target driver
authorDamien Le Moal <dlemoal@kernel.org>
Sat, 4 Jan 2025 04:59:51 +0000 (13:59 +0900)
committerKeith Busch <kbusch@kernel.org>
Sat, 11 Jan 2025 03:30:49 +0000 (19:30 -0800)
commit002ec8f1c69d3722a033eaf45102ba747ae80e94
tree027a39fdac9f7156c34727b71341db236a9bc739
parent0faa0fe6f90ea59b10d1b0f15ce0eb0c18eff186
Documentation: Document the NVMe PCI endpoint target driver

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>
Documentation/PCI/endpoint/index.rst
Documentation/PCI/endpoint/pci-nvme-function.rst [new file with mode: 0644]
Documentation/nvme/index.rst [new file with mode: 0644]
Documentation/nvme/nvme-pci-endpoint-target.rst [new file with mode: 0644]
Documentation/subsystem-apis.rst