diff mbox series

[ovs-dev] Documentation: use new syntax for dpdk port representors

Message ID 20220427081525.44059-1-rjarry@redhat.com
State Accepted
Commit 97873af3734a9300f5eb29f664513edc839cf88a
Headers show
Series [ovs-dev] Documentation: use new syntax for dpdk port representors | expand

Checks

Context Check Description
ovsrobot/apply-robot warning apply and check: warning
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation success test: success

Commit Message

Robin Jarry April 27, 2022, 8:15 a.m. UTC 
Since DPDK 21.05, the representor identifier now handles a relative VF
offset. The legacy representor ID seems only valid in certain cases
(first dpdk port).

Link: https://github.com/DPDK/dpdk/commit/cebf7f17159a8
Signed-off-by: Robin Jarry <rjarry@redhat.com>
---
 Documentation/topics/dpdk/phy.rst | 12 ++++++------
 lib/netdev-dpdk.c                 |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

Comments

0-day Robot April 27, 2022, 8:38 a.m. UTC | #1 
Bleep bloop.  Greetings Robin Jarry, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 92 characters long (recommended limit is 79)
#26 FILE: Documentation/topics/dpdk/phy.rst:270:
__ https://doc.dpdk.org/guides-21.11/prog_guide/switch_representation.html#port-representors

Lines checked: 70, Warnings: 1, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
Ilya Maximets Nov. 2, 2022, 10:42 p.m. UTC | #2 
On 4/27/22 10:15, Robin Jarry wrote:
> Since DPDK 21.05, the representor identifier now handles a relative VF
> offset. The legacy representor ID seems only valid in certain cases
> (first dpdk port).
> 
> Link: https://github.com/DPDK/dpdk/commit/cebf7f17159a8
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> ---
>  Documentation/topics/dpdk/phy.rst | 12 ++++++------
>  lib/netdev-dpdk.c                 |  2 +-
>  2 files changed, 7 insertions(+), 7 deletions(-)

Applied.  Thanks!

Best regards, Ilya Maximets.
diff mbox series

Patch

diff --git a/Documentation/topics/dpdk/phy.rst b/Documentation/topics/dpdk/phy.rst
index 937f4c40e5a8..8fc34a378cb8 100644
--- a/Documentation/topics/dpdk/phy.rst
+++ b/Documentation/topics/dpdk/phy.rst
@@ -267,7 +267,7 @@  Representors are multi devices created on top of one PF.
 
 For more information, refer to the `DPDK documentation`__.
 
-__ https://doc.dpdk.org/guides-21.11/prog_guide/switch_representation.html
+__ https://doc.dpdk.org/guides-21.11/prog_guide/switch_representation.html#port-representors
 
 Prior to port representors there was a one-to-one relationship between the PF
 and the eth device. With port representors the relationship becomes one PF to
@@ -287,18 +287,18 @@  address in devargs. For an existing bridge called ``br0`` and PCI address
 When configuring a VF-based port, DPDK uses an extended devargs syntax which
 has the following format::
 
-    BDBF,representor=[<representor id>]
+    BDBF,representor=<representor identifier>
 
 This syntax shows that a representor is an enumerated eth device (with
-a representor ID) which uses the PF PCI address.
-The following commands add representors 3 and 5 using PCI device address
+a representor identifier) which uses the PF PCI address.
+The following commands add representors of VF 3 and 5 using PCI device address
 ``0000:08:00.0``::
 
     $ ovs-vsctl add-port br0 dpdk-rep3 -- set Interface dpdk-rep3 type=dpdk \
-       options:dpdk-devargs=0000:08:00.0,representor=[3]
+       options:dpdk-devargs=0000:08:00.0,representor=vf3
 
     $ ovs-vsctl add-port br0 dpdk-rep5 -- set Interface dpdk-rep5 type=dpdk \
-       options:dpdk-devargs=0000:08:00.0,representor=[5]
+       options:dpdk-devargs=0000:08:00.0,representor=vf5
 
 .. important::
 
diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
index e0a2dccf5ce1..95f491081a11 100644
--- a/lib/netdev-dpdk.c
+++ b/lib/netdev-dpdk.c
@@ -1772,7 +1772,7 @@  static dpdk_port_t netdev_dpdk_get_port_by_devargs(const char *devargs)
 }
 
 /*
- * Normally, a PCI id (optionally followed by a representor number)
+ * Normally, a PCI id (optionally followed by a representor identifier)
  * is enough for identifying a specific DPDK port.
  * However, for some NICs having multiple ports sharing the same PCI
  * id, using PCI id won't work then.