doc: include note for pci address naming in ip pipeline

Message ID 20180720130906.82895-1-kevin.laatz@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: include note for pci address naming in ip pipeline |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Kevin Laatz July 20, 2018, 1:09 p.m. UTC
  Add a note to the 'link' command in the IP Pipeline documentation
specifying the PCI device name format required to run the application.

Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
---
 doc/guides/sample_app_ug/ip_pipeline.rst | 1 +
 1 file changed, 1 insertion(+)
  

Comments

Thomas Monjalon Aug. 1, 2018, 3:56 p.m. UTC | #1
Cristian, review please?

20/07/2018 15:09, Kevin Laatz:
> Add a note to the 'link' command in the IP Pipeline documentation
> specifying the PCI device name format required to run the application.
> 
> Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
> ---
>  doc/guides/sample_app_ug/ip_pipeline.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst
> index 660798d..dc6a3b9 100644
> --- a/doc/guides/sample_app_ug/ip_pipeline.rst
> +++ b/doc/guides/sample_app_ug/ip_pipeline.rst
> @@ -222,6 +222,7 @@ Link
>      txq <n_queues> <queue_size> promiscuous on | off
>      [rss <qid_0> ... <qid_n>]
>  
> +   Note: The PCI device name must be specified in the Domain:Bus:Device.Function format.
>  
>  Mempool
>  ~~~~~~~
>
  
Cristian Dumitrescu Aug. 1, 2018, 5:47 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Wednesday, August 1, 2018 4:56 PM
> To: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: dev@dpdk.org; Laatz, Kevin <kevin.laatz@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: include note for pci address naming in
> ip pipeline
> 
> Cristian, review please?
> 
> 20/07/2018 15:09, Kevin Laatz:
> > Add a note to the 'link' command in the IP Pipeline documentation
> > specifying the PCI device name format required to run the application.
> >
> > Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
> > ---
> >  doc/guides/sample_app_ug/ip_pipeline.rst | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst
> b/doc/guides/sample_app_ug/ip_pipeline.rst
> > index 660798d..dc6a3b9 100644
> > --- a/doc/guides/sample_app_ug/ip_pipeline.rst
> > +++ b/doc/guides/sample_app_ug/ip_pipeline.rst
> > @@ -222,6 +222,7 @@ Link
> >      txq <n_queues> <queue_size> promiscuous on | off
> >      [rss <qid_0> ... <qid_n>]
> >
> > +   Note: The PCI device name must be specified in the
> Domain:Bus:Device.Function format.
> >
> >  Mempool
> >  ~~~~~~~
> >
> 
> 
> 
> 

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
  
Thomas Monjalon Aug. 5, 2018, 6:28 p.m. UTC | #3
01/08/2018 19:47, Dumitrescu, Cristian:
> > 20/07/2018 15:09, Kevin Laatz:
> > > Add a note to the 'link' command in the IP Pipeline documentation
> > > specifying the PCI device name format required to run the application.
> > >
> > > Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
> 
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst
index 660798d..dc6a3b9 100644
--- a/doc/guides/sample_app_ug/ip_pipeline.rst
+++ b/doc/guides/sample_app_ug/ip_pipeline.rst
@@ -222,6 +222,7 @@  Link
     txq <n_queues> <queue_size> promiscuous on | off
     [rss <qid_0> ... <qid_n>]
 
+   Note: The PCI device name must be specified in the Domain:Bus:Device.Function format.
 
 Mempool
 ~~~~~~~