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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZLJhXRdA2a72Cb5/@corigine.com>
Date: Sat, 15 Jul 2023 10:05:33 +0100
From: Simon Horman <simon.horman@...igine.com>
To: Brett Creeley <brett.creeley@....com>
Cc: kvm@...r.kernel.org, netdev@...r.kernel.org, alex.williamson@...hat.com,
	jgg@...dia.com, yishaih@...dia.com,
	shameerali.kolothum.thodi@...wei.com, kevin.tian@...el.com,
	shannon.nelson@....com
Subject: Re: [PATCH v11 vfio 7/7] vfio/pds: Add Kconfig and documentation

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@....com>
> Signed-off-by: Shannon Nelson <shannon.nelson@....com>
> Reviewed-by: Simon Horman <simon.horman@...igine.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?

'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