doc: fix PCI whitelist typo in prog guide

Message ID 20190224223259.17685-1-thomas@monjalon.net
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: fix PCI whitelist typo in prog guide
Related show

Checks

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

Commit Message

Thomas Monjalon Feb. 24, 2019, 10:32 p.m.
The placeholder for PCI address should be named DBDF
which stands for Domain/Bus/Device/Function.

Fixes: 33af337773ac ("ethdev: add common devargs parser")
Cc: remy.horton@intel.com
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/prog_guide/poll_mode_drv.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Rami Rosen Feb. 25, 2019, 5:23 a.m. | #1
Reviewed-by: Rami Rosen <ramirose at gmail.com>

On Mon, Feb 25, 2019 at 12:33 AM Thomas Monjalon <thomas@monjalon.net>
wrote:

> The placeholder for PCI address should be named DBDF
> which stands for Domain/Bus/Device/Function.
>
> Fixes: 33af337773ac ("ethdev: add common devargs parser")
> Cc: remy.horton@intel.com
> Cc: stable@dpdk.org
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/prog_guide/poll_mode_drv.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/doc/guides/prog_guide/poll_mode_drv.rst
> b/doc/guides/prog_guide/poll_mode_drv.rst
> index b2cf483546..6fae39f904 100644
> --- a/doc/guides/prog_guide/poll_mode_drv.rst
> +++ b/doc/guides/prog_guide/poll_mode_drv.rst
> @@ -374,9 +374,9 @@ parameters to those ports.
>    this argument allows user to specify which switch ports to enable port
>    representors for.::
>
> -   -w BDBF,representor=0
> -   -w BDBF,representor=[0,4,6,9]
> -   -w BDBF,representor=[0-31]
> +   -w DBDF,representor=0
> +   -w DBDF,representor=[0,4,6,9]
> +   -w DBDF,representor=[0-31]
>
>  Note: PMDs are not required to support the standard device arguments and
> users
>  should consult the relevant PMD documentation to see support devargs.
> --
> 2.20.1
>
>
Ferruh Yigit March 5, 2019, 11:59 a.m. | #2
On 2/25/2019 5:23 AM, Rami Rosen wrote:

> On Mon, Feb 25, 2019 at 12:33 AM Thomas Monjalon <thomas@monjalon.net>
> wrote:
> 
>> The placeholder for PCI address should be named DBDF
>> which stands for Domain/Bus/Device/Function.
>>
>> Fixes: 33af337773ac ("ethdev: add common devargs parser")
>> Cc: remy.horton@intel.com
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
> Reviewed-by: Rami Rosen <ramirose at gmail.com>
>

Applied, thanks.

Patch

diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst
index b2cf483546..6fae39f904 100644
--- a/doc/guides/prog_guide/poll_mode_drv.rst
+++ b/doc/guides/prog_guide/poll_mode_drv.rst
@@ -374,9 +374,9 @@  parameters to those ports.
   this argument allows user to specify which switch ports to enable port
   representors for.::
 
-   -w BDBF,representor=0
-   -w BDBF,representor=[0,4,6,9]
-   -w BDBF,representor=[0-31]
+   -w DBDF,representor=0
+   -w DBDF,representor=[0,4,6,9]
+   -w DBDF,representor=[0-31]
 
 Note: PMDs are not required to support the standard device arguments and users
 should consult the relevant PMD documentation to see support devargs.