[PATCH v6 18/18] Documentation: Document the NVMe PCI endpoint target driver

[Damien Le Moal]

On 12/20/24 17:14, Manivannan Sadhasivam wrote:
> On Fri, Dec 20, 2024 at 12:54:41PM +0900, Damien Le Moal wrote:
>> 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 at kernel.org>
> 
> Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam at linaro.org>

Thanks.

> [...]
> 
>> +Configure the function using any device ID (the vendor ID for the device will
>> +be automatically set to the same value as the NVMe target subsystem vendor
>> +ID)::
>> +
>> +        # cd /sys/kernel/config/pci_ep/functions/nvmet_pci_epf
>> +        # echo 0xBEEF > nvmepf.0/deviceid
> 
> It'd be good to mention that the vendor id set with nvmet configfs will be
> reused here.

Please re-read the sentence above the commands. I added exactly that :)

-- 
Damien Le Moal
Western Digital Research