[v2,1/2] doc: make the Linux drivers doc more generic

Message ID 20221115195914.34700-2-nicolas.chautru@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: simplify PMD steps |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Chautru, Nicolas Nov. 15, 2022, 7:59 p.m. UTC
  Minor change so that for the documentation to be less NIC centric,
as these steps can apply more generally to PCIe devices.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/linux_gsg/linux_drivers.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
  

Comments

Thomas Monjalon Nov. 22, 2022, 2:59 p.m. UTC | #1
15/11/2022 20:59, Nicolas Chautru:
> Minor change so that for the documentation to be less NIC centric,
> as these steps can apply more generally to PCIe devices.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
[...]
>  Different PMDs may require different kernel drivers in order to work properly.
>  Depending on the PMD being used, a corresponding kernel driver should be loaded,
> -and network ports should be bound to that driver.
> +and network ports or other hardware devices should be bound to that driver.

We could completely remove "network ports".
There are more places in this doc which should be made more generic.

I keep this patch open to remind to work on it.
Anybody is welcome to improve this patch.
  
Chautru, Nicolas March 6, 2023, 5:41 p.m. UTC | #2
Hi Thomas, 

Any update with regards to that series? Unsure how much more you want it to become generic. Ie. replacing most of "network port" by "PCIe device"

Thanks
Nic

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, November 22, 2022 6:59 AM
> To: Chautru, Nicolas <nicolas.chautru@intel.com>
> Cc: dev@dpdk.org; gakhil@marvell.com; maxime.coquelin@redhat.com;
> Vargas, Hernan <hernan.vargas@intel.com>
> Subject: Re: [PATCH v2 1/2] doc: make the Linux drivers doc more generic
> 
> 15/11/2022 20:59, Nicolas Chautru:
> > Minor change so that for the documentation to be less NIC centric, as
> > these steps can apply more generally to PCIe devices.
> >
> > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> [...]
> >  Different PMDs may require different kernel drivers in order to work
> properly.
> >  Depending on the PMD being used, a corresponding kernel driver should
> > be loaded, -and network ports should be bound to that driver.
> > +and network ports or other hardware devices should be bound to that driver.
> 
> We could completely remove "network ports".
> There are more places in this doc which should be made more generic.
> 
> I keep this patch open to remind to work on it.
> Anybody is welcome to improve this patch.
> 
>
  
Thomas Monjalon March 6, 2023, 7:46 p.m. UTC | #3
06/03/2023 18:41, Chautru, Nicolas:
> Hi Thomas, 
> 
> Any update with regards to that series? Unsure how much more you want it to become generic. Ie. replacing most of "network port" by "PCIe device"

Devices are not always PCI based.
The doc should reviewed entirely to make sure it is not restricted
to network ports or PCI devices.


> From: Thomas Monjalon <thomas@monjalon.net>
> > 15/11/2022 20:59, Nicolas Chautru:
> > > Minor change so that for the documentation to be less NIC centric, as
> > > these steps can apply more generally to PCIe devices.
> > >
> > > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > [...]
> > >  Different PMDs may require different kernel drivers in order to work
> > properly.
> > >  Depending on the PMD being used, a corresponding kernel driver should
> > > be loaded, -and network ports should be bound to that driver.
> > > +and network ports or other hardware devices should be bound to that driver.
> > 
> > We could completely remove "network ports".
> > There are more places in this doc which should be made more generic.
> > 
> > I keep this patch open to remind to work on it.
> > Anybody is welcome to improve this patch.
  
Chautru, Nicolas March 9, 2023, 5:35 p.m. UTC | #4
> From: Thomas Monjalon <thomas@monjalon.net>
> 06/03/2023 18:41, Chautru, Nicolas:
> > Hi Thomas,
> >
> > Any update with regards to that series? Unsure how much more you want it
> to become generic. Ie. replacing most of "network port" by "PCIe device"
> 
> Devices are not always PCI based.
> The doc should reviewed entirely to make sure it is not restricted to network
> ports or PCI devices.

OK not familiar myself with all these other variants, I did not realize you wanted to extend the scope that much. 
Have you got an ETA for such a doc update?

> > From: Thomas Monjalon <thomas@monjalon.net>
> > > 15/11/2022 20:59, Nicolas Chautru:
> > > > Minor change so that for the documentation to be less NIC centric,
> > > > as these steps can apply more generally to PCIe devices.
> > > >
> > > > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > > [...]
> > > >  Different PMDs may require different kernel drivers in order to
> > > > work
> > > properly.
> > > >  Depending on the PMD being used, a corresponding kernel driver
> > > > should be loaded, -and network ports should be bound to that driver.
> > > > +and network ports or other hardware devices should be bound to that
> driver.
> > >
> > > We could completely remove "network ports".
> > > There are more places in this doc which should be made more generic.
> > >
> > > I keep this patch open to remind to work on it.
> > > Anybody is welcome to improve this patch.
> 
>
  
Thomas Monjalon March 9, 2023, 6:08 p.m. UTC | #5
09/03/2023 18:35, Chautru, Nicolas:
> 
> > From: Thomas Monjalon <thomas@monjalon.net>
> > 06/03/2023 18:41, Chautru, Nicolas:
> > > Hi Thomas,
> > >
> > > Any update with regards to that series? Unsure how much more you want it
> > to become generic. Ie. replacing most of "network port" by "PCIe device"
> > 
> > Devices are not always PCI based.
> > The doc should reviewed entirely to make sure it is not restricted to network
> > ports or PCI devices.
> 
> OK not familiar myself with all these other variants, I did not realize you wanted to extend the scope that much. 
> Have you got an ETA for such a doc update?

No ETA, that's why I asked who could help here.


> > > From: Thomas Monjalon <thomas@monjalon.net>
> > > > 15/11/2022 20:59, Nicolas Chautru:
> > > > > Minor change so that for the documentation to be less NIC centric,
> > > > > as these steps can apply more generally to PCIe devices.
> > > > >
> > > > > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > > > [...]
> > > > >  Different PMDs may require different kernel drivers in order to
> > > > > work
> > > > properly.
> > > > >  Depending on the PMD being used, a corresponding kernel driver
> > > > > should be loaded, -and network ports should be bound to that driver.
> > > > > +and network ports or other hardware devices should be bound to that
> > driver.
> > > >
> > > > We could completely remove "network ports".
> > > > There are more places in this doc which should be made more generic.
> > > >
> > > > I keep this patch open to remind to work on it.
> > > > Anybody is welcome to improve this patch.
  

Patch

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 2f3f079aab..4f6524ef67 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -12,12 +12,12 @@  Linux Drivers
 
 Different PMDs may require different kernel drivers in order to work properly.
 Depending on the PMD being used, a corresponding kernel driver should be loaded,
-and network ports should be bound to that driver.
+and network ports or other hardware devices should be bound to that driver.
 
 .. _linux_gsg_binding_kernel:
 
-Binding and Unbinding Network Ports to/from the Kernel Modules
---------------------------------------------------------------
+Binding and Unbinding to/from the Kernel Modules
+------------------------------------------------
 
 .. note::