DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: fix nfp multiport syntax
@ 2021-02-25 11:46 Heinrich Kuhn
  2021-03-01 13:45 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
  0 siblings, 1 reply; 6+ messages in thread
From: Heinrich Kuhn @ 2021-02-25 11:46 UTC (permalink / raw)
  To: dev; +Cc: Chaoyong.He, stable, Heinrich Kuhn

From: "Chaoyong.He" <chaoyong.he@corigine.com>

1. Fixup the suffix of the PCI ID to be consistent with the code.
2. Add specification of using MAC address to identify port.

Fixes: 979f2bae0 ("doc: improve multiport PF in nfp guide")
Cc: stable@dpdk.org

Signed-off-by: Chaoyong.He <chaoyong.he@corigine.com>
Signed-off-by: Heinrich Kuhn <heinrich.kuhn@netronome.com>
---
 doc/guides/nics/nfp.rst | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
index fef99973b..2b170539d 100644
--- a/doc/guides/nics/nfp.rst
+++ b/doc/guides/nics/nfp.rst
@@ -117,15 +117,19 @@ although once they are created, DPDK apps should be able to use them as normal
 PCI ports.
 
 NFP ports belonging to same PF can be seen inside PMD initialization with a
-suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
+suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID
 0000:03:00.0 and four ports is seen by the PMD code as:
 
    .. code-block:: console
 
-      0000:03:00.0_port_0
-      0000:03:00.0_port_1
-      0000:03:00.0_port_2
-      0000:03:00.0_port_3
+      0000:03:00.0_port0
+      0000:03:00.0_port1
+      0000:03:00.0_port2
+      0000:03:00.0_port3
+
+Some dpdk applications can choose to use the MAC address to identify ports,
+OVS-DPDK is one such example, please refer to:
+https://docs.openvswitch.org/en/latest/howto/dpdk/
 
    .. Note::
 
-- 
2.30.0


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix nfp multiport syntax
  2021-02-25 11:46 [dpdk-dev] [PATCH] doc: fix nfp multiport syntax Heinrich Kuhn
@ 2021-03-01 13:45 ` Ferruh Yigit
  2021-04-23 16:18   ` Ferruh Yigit
  0 siblings, 1 reply; 6+ messages in thread
From: Ferruh Yigit @ 2021-03-01 13:45 UTC (permalink / raw)
  To: Heinrich Kuhn, dev; +Cc: Chaoyong.He, stable

On 2/25/2021 11:46 AM, Heinrich Kuhn wrote:
> From: "Chaoyong.He" <chaoyong.he@corigine.com>
> 
> 1. Fixup the suffix of the PCI ID to be consistent with the code.
> 2. Add specification of using MAC address to identify port.
> 
> Fixes: 979f2bae0 ("doc: improve multiport PF in nfp guide")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Chaoyong.He <chaoyong.he@corigine.com>
> Signed-off-by: Heinrich Kuhn <heinrich.kuhn@netronome.com>
> ---
>   doc/guides/nics/nfp.rst | 14 +++++++++-----
>   1 file changed, 9 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
> index fef99973b..2b170539d 100644
> --- a/doc/guides/nics/nfp.rst
> +++ b/doc/guides/nics/nfp.rst
> @@ -117,15 +117,19 @@ although once they are created, DPDK apps should be able to use them as normal
>   PCI ports.
>   
>   NFP ports belonging to same PF can be seen inside PMD initialization with a
> -suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
> +suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID
>   0000:03:00.0 and four ports is seen by the PMD code as:
>   
>      .. code-block:: console
>   
> -      0000:03:00.0_port_0
> -      0000:03:00.0_port_1
> -      0000:03:00.0_port_2
> -      0000:03:00.0_port_3
> +      0000:03:00.0_port0
> +      0000:03:00.0_port1
> +      0000:03:00.0_port2
> +      0000:03:00.0_port3
> +

+1 to fix.

> +Some dpdk applications can choose to use the MAC address to identify ports,
> +OVS-DPDK is one such example, please refer to:
> +https://docs.openvswitch.org/en/latest/howto/dpdk/

This is not PMD specific information, not sure to have here,
also not sure to have an external link here, basically for the maintenance 
concerns, should we document this usage withing DPDK in a wider than a PMD scope?


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix nfp multiport syntax
  2021-03-01 13:45 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
@ 2021-04-23 16:18   ` Ferruh Yigit
  2021-04-26  9:46     ` Ferruh Yigit
  0 siblings, 1 reply; 6+ messages in thread
From: Ferruh Yigit @ 2021-04-23 16:18 UTC (permalink / raw)
  To: Heinrich Kuhn, dev

On 3/1/2021 1:45 PM, Ferruh Yigit wrote:
> On 2/25/2021 11:46 AM, Heinrich Kuhn wrote:
>> From: "Chaoyong.He" <chaoyong.he@corigine.com>
>>
>> 1. Fixup the suffix of the PCI ID to be consistent with the code.
>> 2. Add specification of using MAC address to identify port.
>>
>> Fixes: 979f2bae0 ("doc: improve multiport PF in nfp guide")
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Chaoyong.He <chaoyong.he@corigine.com>
>> Signed-off-by: Heinrich Kuhn <heinrich.kuhn@netronome.com>
>> ---
>>   doc/guides/nics/nfp.rst | 14 +++++++++-----
>>   1 file changed, 9 insertions(+), 5 deletions(-)
>>
>> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
>> index fef99973b..2b170539d 100644
>> --- a/doc/guides/nics/nfp.rst
>> +++ b/doc/guides/nics/nfp.rst
>> @@ -117,15 +117,19 @@ although once they are created, DPDK apps should be able 
>> to use them as normal
>>   PCI ports.
>>   NFP ports belonging to same PF can be seen inside PMD initialization with a
>> -suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
>> +suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID
>>   0000:03:00.0 and four ports is seen by the PMD code as:
>>      .. code-block:: console
>> -      0000:03:00.0_port_0
>> -      0000:03:00.0_port_1
>> -      0000:03:00.0_port_2
>> -      0000:03:00.0_port_3
>> +      0000:03:00.0_port0
>> +      0000:03:00.0_port1
>> +      0000:03:00.0_port2
>> +      0000:03:00.0_port3
>> +
> 
> +1 to fix.
> 
>> +Some dpdk applications can choose to use the MAC address to identify ports,
>> +OVS-DPDK is one such example, please refer to:
>> +https://docs.openvswitch.org/en/latest/howto/dpdk/
> 
> This is not PMD specific information, not sure to have here,
> also not sure to have an external link here, basically for the maintenance 
> concerns, should we document this usage withing DPDK in a wider than a PMD scope?
> 

Ping.

Will there be a new version?
If not I can just get the fix part (s/port_n/portn).

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix nfp multiport syntax
  2021-04-23 16:18   ` Ferruh Yigit
@ 2021-04-26  9:46     ` Ferruh Yigit
  2021-04-26  9:48       ` Ferruh Yigit
  0 siblings, 1 reply; 6+ messages in thread
From: Ferruh Yigit @ 2021-04-26  9:46 UTC (permalink / raw)
  To: Heinrich Kuhn; +Cc: dev

On 4/23/2021 5:18 PM, Ferruh Yigit wrote:
> On 3/1/2021 1:45 PM, Ferruh Yigit wrote:
>> On 2/25/2021 11:46 AM, Heinrich Kuhn wrote:
>>> From: "Chaoyong.He" <chaoyong.he@corigine.com>
>>>
>>> 1. Fixup the suffix of the PCI ID to be consistent with the code.
>>> 2. Add specification of using MAC address to identify port.
>>>
>>> Fixes: 979f2bae0 ("doc: improve multiport PF in nfp guide")
>>> Cc: stable@dpdk.org
>>>
>>> Signed-off-by: Chaoyong.He <chaoyong.he@corigine.com>
>>> Signed-off-by: Heinrich Kuhn <heinrich.kuhn@netronome.com>
>>> ---
>>>   doc/guides/nics/nfp.rst | 14 +++++++++-----
>>>   1 file changed, 9 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
>>> index fef99973b..2b170539d 100644
>>> --- a/doc/guides/nics/nfp.rst
>>> +++ b/doc/guides/nics/nfp.rst
>>> @@ -117,15 +117,19 @@ although once they are created, DPDK apps should be 
>>> able to use them as normal
>>>   PCI ports.
>>>   NFP ports belonging to same PF can be seen inside PMD initialization with a
>>> -suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
>>> +suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID
>>>   0000:03:00.0 and four ports is seen by the PMD code as:
>>>      .. code-block:: console
>>> -      0000:03:00.0_port_0
>>> -      0000:03:00.0_port_1
>>> -      0000:03:00.0_port_2
>>> -      0000:03:00.0_port_3
>>> +      0000:03:00.0_port0
>>> +      0000:03:00.0_port1
>>> +      0000:03:00.0_port2
>>> +      0000:03:00.0_port3
>>> +
>>
>> +1 to fix.
>>
>>> +Some dpdk applications can choose to use the MAC address to identify ports,
>>> +OVS-DPDK is one such example, please refer to:
>>> +https://docs.openvswitch.org/en/latest/howto/dpdk/
>>
>> This is not PMD specific information, not sure to have here,
>> also not sure to have an external link here, basically for the maintenance 
>> concerns, should we document this usage withing DPDK in a wider than a PMD scope?
>>
> 
> Ping.
> 
> Will there be a new version?
> If not I can just get the fix part (s/port_n/portn).

Partially, for the fix part,
Applied to dpdk-next-net/main, thanks.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix nfp multiport syntax
  2021-04-26  9:46     ` Ferruh Yigit
@ 2021-04-26  9:48       ` Ferruh Yigit
  2021-04-26 13:51         ` Thomas Monjalon
  0 siblings, 1 reply; 6+ messages in thread
From: Ferruh Yigit @ 2021-04-26  9:48 UTC (permalink / raw)
  To: Thomas Monjalon, David Marchand, Akhil Goyal, jerinj,
	Maxime Coquelin, Qi Zhang, Raslan Darawsheh, Ajit Khaparde
  Cc: dev, Heinrich Kuhn, techboard

On 4/26/2021 10:46 AM, Ferruh Yigit wrote:
> On 4/23/2021 5:18 PM, Ferruh Yigit wrote:
>> On 3/1/2021 1:45 PM, Ferruh Yigit wrote:
>>> On 2/25/2021 11:46 AM, Heinrich Kuhn wrote:
>>>> From: "Chaoyong.He" <chaoyong.he@corigine.com>
>>>>
>>>> 1. Fixup the suffix of the PCI ID to be consistent with the code.
>>>> 2. Add specification of using MAC address to identify port.
>>>>
>>>> Fixes: 979f2bae0 ("doc: improve multiport PF in nfp guide")
>>>> Cc: stable@dpdk.org
>>>>
>>>> Signed-off-by: Chaoyong.He <chaoyong.he@corigine.com>
>>>> Signed-off-by: Heinrich Kuhn <heinrich.kuhn@netronome.com>
>>>> ---
>>>>   doc/guides/nics/nfp.rst | 14 +++++++++-----
>>>>   1 file changed, 9 insertions(+), 5 deletions(-)
>>>>
>>>> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
>>>> index fef99973b..2b170539d 100644
>>>> --- a/doc/guides/nics/nfp.rst
>>>> +++ b/doc/guides/nics/nfp.rst
>>>> @@ -117,15 +117,19 @@ although once they are created, DPDK apps should be 
>>>> able to use them as normal
>>>>   PCI ports.
>>>>   NFP ports belonging to same PF can be seen inside PMD initialization with a
>>>> -suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
>>>> +suffix added to the PCI ID: wwww:xx:yy.z_portn. For example, a PF with PCI ID
>>>>   0000:03:00.0 and four ports is seen by the PMD code as:
>>>>      .. code-block:: console
>>>> -      0000:03:00.0_port_0
>>>> -      0000:03:00.0_port_1
>>>> -      0000:03:00.0_port_2
>>>> -      0000:03:00.0_port_3
>>>> +      0000:03:00.0_port0
>>>> +      0000:03:00.0_port1
>>>> +      0000:03:00.0_port2
>>>> +      0000:03:00.0_port3
>>>> +
>>>
>>> +1 to fix.
>>>
>>>> +Some dpdk applications can choose to use the MAC address to identify ports,
>>>> +OVS-DPDK is one such example, please refer to:
>>>> +https://docs.openvswitch.org/en/latest/howto/dpdk/
>>>
>>> This is not PMD specific information, not sure to have here,
>>> also not sure to have an external link here, basically for the maintenance 
>>> concerns, should we document this usage withing DPDK in a wider than a PMD 
>>> scope?
>>>
>>
>> Ping.
>>
>> Will there be a new version?
>> If not I can just get the fix part (s/port_n/portn).
> 
> Partially, for the fix part,
> Applied to dpdk-next-net/main, thanks.


Hi Thomas, David, Akhil, Jerin, Maxime, Qi, Raslan, Ajit,

For the doc patches, the subsystem prefix 'doc:' is too wide, what do you think 
to extend it to include the component, like for this patch:
"doc/nics/nfp: fix multiport syntax"

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix nfp multiport syntax
  2021-04-26  9:48       ` Ferruh Yigit
@ 2021-04-26 13:51         ` Thomas Monjalon
  0 siblings, 0 replies; 6+ messages in thread
From: Thomas Monjalon @ 2021-04-26 13:51 UTC (permalink / raw)
  To: Ferruh Yigit, David Marchand, gakhil, Jerin Jacob Kollanukkaran,
	Maxime Coquelin, Qi Zhang, Raslan Darawsheh, Ajit Khaparde
  Cc: dev, Heinrich Kuhn, techboard

Lun 26 avr 2021, à 11:48, Ferruh Yigit a écrit :
> Hi Thomas, David, Akhil, Jerin, Maxime, Qi, Raslan, Ajit,
> 
> For the doc patches, the subsystem prefix 'doc:' is too wide, what do you think 
> to extend it to include the component, like for this patch:
> "doc/nics/nfp: fix multiport syntax"

Usually I format like this:
doc: fix multiport syntax in nfp guide

I am not sure about being precise in the doc prefix for 2 reasons:
- the doc hierarchy can be quite complex
- it may give too much importance visually to the doc changes

But if everybody prefer a precise prefix, I am OK to change the habit.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-04-26 13:51 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-02-25 11:46 [dpdk-dev] [PATCH] doc: fix nfp multiport syntax Heinrich Kuhn
2021-03-01 13:45 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
2021-04-23 16:18   ` Ferruh Yigit
2021-04-26  9:46     ` Ferruh Yigit
2021-04-26  9:48       ` Ferruh Yigit
2021-04-26 13:51         ` Thomas Monjalon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).