summaryrefslogtreecommitdiff
path: root/Documentation/nvme
AgeCommit message (Collapse)AuthorFilesLines
2025-07-17docs: nvme: fix grammar in nvme-pci-endpoint-target.rstAlok Tiwari1-11/+11
Notable changes: - Use "an NVMe" instead of "a NVMe" throughout the document - Fix incorrect phrasing such as "will is discoverable" -> "is discoverable" - Ensure consistent and proper article usage for clarity. Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com> Signed-off-by: Christoph Hellwig <hch@lst.de>
2025-02-19Documentation: typo fixesArmin Mahdilou1-1/+1
Fixed some spelling issues in documentations. Signed-off-by: Armin Mahdilou <Armin.Mahdilou@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250210192754.30283-1-Armin.Mahdilou@gmail.com
2025-01-11Documentation: Document the NVMe PCI endpoint target driverDamien Le Moal2-0/+380
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>
2024-09-11Remove duplicate "and" in 'Linux NVMe docs.Shivam Chaudhary1-3/+3
Remove duplicate occurrence of 'and' in 'Linux NVMe Feature and Quirk Policy' title heading. tested: Not breaking anything. Signed-off-by: Shivam Chaudhary <cvam0000@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20240910052737.30579-1-cvam0000@gmail.com>
2022-12-28docs, nvme: add a feature and quirk policy documentChristoph Hellwig1-0/+77
This adds a document about what specification features are supported by the Linux NVMe driver, and what qualifies for a quirk if an implementation has problems following the specification. Signed-off-by: Jens Axboe <axboe@kernel.dk> Signed-off-by: Keith Busch <kbusch@kernel.org> Signed-off-by: Sagi Grimberg <sagi@grimberg.me> Signed-off-by: Christoph Hellwig <hch@lst.de> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Jonathan Corbet <corbet@lwn.net>