Re: [PATCH v11 vfio 7/7] vfio/pds: Add Kconfig and documentation

[Brett Creeley <bcreeley@amd.com>]

On 7/15/2023 2:05 AM, Simon Horman wrote:
> Caution: This message originated from an External Source. Use proper caution when opening attachments, clicking links, or responding.
> 
> 
> On Wed, Jul 12, 2023 at 05:37:27PM -0700, Brett Creeley wrote:
>> Add Kconfig entries and pds-vfio-pci.rst. Also, add an entry in the
>> MAINTAINERS file for this new driver.
>>
>> It's not clear where documentation for vendor specific VFIO
>> drivers should live, so just re-use the current amd
>> ethernet location.
>>
>> Signed-off-by: Brett Creeley <brett.creeley@amd.com>
>> Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
>> Reviewed-by: Simon Horman <simon.horman@corigine.com>
>> ---
>>   .../ethernet/amd/pds-vfio-pci.rst             | 79 +++++++++++++++++++
>>   .../device_drivers/ethernet/index.rst         |  1 +
>>   MAINTAINERS                                   |  7 ++
>>   drivers/vfio/pci/Kconfig                      |  2 +
>>   drivers/vfio/pci/pds/Kconfig                  | 19 +++++
>>   5 files changed, 108 insertions(+)
>>   create mode 100644 Documentation/networking/device_drivers/ethernet/amd/pds-vfio-pci.rst
>>   create mode 100644 drivers/vfio/pci/pds/Kconfig
>>
>> diff --git a/Documentation/networking/device_drivers/ethernet/amd/pds-vfio-pci.rst b/Documentation/networking/device_drivers/ethernet/amd/pds-vfio-pci.rst
>> new file mode 100644
>> index 000000000000..7a6bc848a2b2
>> --- /dev/null
>> +++ b/Documentation/networking/device_drivers/ethernet/amd/pds-vfio-pci.rst
>> @@ -0,0 +1,79 @@
> 
> ...
> 
>> diff --git a/Documentation/networking/device_drivers/ethernet/index.rst b/Documentation/networking/device_drivers/ethernet/index.rst
>> index 94ecb67c0885..804e1f7c461c 100644
>> --- a/Documentation/networking/device_drivers/ethernet/index.rst
>> +++ b/Documentation/networking/device_drivers/ethernet/index.rst
>> @@ -16,6 +16,7 @@ Contents:
>>      altera/altera_tse
>>      amd/pds_core
>>      amd/pds_vdpa
>> +   amd/pds_vfio
>>      aquantia/atlantic
>>      chelsio/cxgb
>>      cirrus/cs89x0
> 
> Sorry for not noticing this, but there seems to be a missmatch
> between 'amd/pds_vfio' above, and the name of the file in
> question. Perhaps the file should be renamed pds_vfio.rst?

I will take a look at this. I renamed comments/files based on renaming 
the driver to pds-vfio-pci, but missed this.

Thanks for taking another look. I will get this fixed on v12.

Brett

> 
> 'make htmldocs' reports:
> 
>   .../index.rst:10: WARNING: toctree contains reference to nonexisting document 'device_drivers/ethernet/amd/pds_vfio'
>   .../amd/pds-vfio-pci.rst: WARNING: document isn't included in any toctree
> 
> 
>