DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH v1] doc: fix CI typo warnings
@ 2021-08-09 13:06 Ray Kinsella
  2021-08-09 14:43 ` Aaron Conole
  2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
  0 siblings, 2 replies; 11+ messages in thread
From: Ray Kinsella @ 2021-08-09 13:06 UTC (permalink / raw)
  To: dev; +Cc: bruce.richardson, aconole, john.mcnamara, Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
---
 doc/guides/sample_app_ug/ioat.rst            | 2 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
index ee0a627b06..b364be3b5d 100644
--- a/doc/guides/sample_app_ug/ioat.rst
+++ b/doc/guides/sample_app_ug/ioat.rst
@@ -236,7 +236,7 @@ function in order to start processing for each lcore:
 .. literalinclude:: ../../../examples/ioat/ioatfwd.c
     :language: c
     :start-after: Start processing for each lcore. 8<
-    :end-before: >8 End of starting to processfor each lcore.
+    :end-before: >8 End of starting to process for each lcore.
     :dedent: 0
 
 The function launches Rx/Tx processing functions on configured lcores
diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst
index ae1b5660df..ed28525a15 100644
--- a/doc/guides/sample_app_ug/vmdq_forwarding.rst
+++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst
@@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02.
 
 .. literalinclude:: ../../../examples/vmdq/main.c
     :language: c
-    :start-after: Building correct configruration for vdmq. 8<
+    :start-after: Building correct configuration for vdmq. 8<
     :end-before: >8 End of get_eth_conf.
 
 Once the network port has been initialized using the correct VMDq values,
-- 
2.26.2


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

* Re: [dpdk-dev] [PATCH v1] doc: fix CI typo warnings
  2021-08-09 13:06 [dpdk-dev] [PATCH v1] doc: fix CI typo warnings Ray Kinsella
@ 2021-08-09 14:43 ` Aaron Conole
  2021-08-10 13:59   ` Kinsella, Ray
  2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
  1 sibling, 1 reply; 11+ messages in thread
From: Aaron Conole @ 2021-08-09 14:43 UTC (permalink / raw)
  To: Ray Kinsella; +Cc: dev, bruce.richardson, john.mcnamara

Ray Kinsella <mdr@ashroe.eu> writes:

> Fix documentation typos that are generating spurious CI warnings.
>
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
> ---

Looks like there are still a few errors.  Ex:

ioat: end-before not used anywhere

deprecation.rst: 'inplace' should probably be 'in place'
deprecation.rst: 'esn' -> probably needs a way to exempt this particular
'word' / line, because it is a function name.  I'm surprised it is even
considered.

Is it possible to spin a v2 with these fixes?

>  doc/guides/sample_app_ug/ioat.rst            | 2 +-
>  doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
> index ee0a627b06..b364be3b5d 100644
> --- a/doc/guides/sample_app_ug/ioat.rst
> +++ b/doc/guides/sample_app_ug/ioat.rst
> @@ -236,7 +236,7 @@ function in order to start processing for each lcore:
>  .. literalinclude:: ../../../examples/ioat/ioatfwd.c
>      :language: c
>      :start-after: Start processing for each lcore. 8<
> -    :end-before: >8 End of starting to processfor each lcore.
> +    :end-before: >8 End of starting to process for each lcore.
>      :dedent: 0
>  
>  The function launches Rx/Tx processing functions on configured lcores
> diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst
> index ae1b5660df..ed28525a15 100644
> --- a/doc/guides/sample_app_ug/vmdq_forwarding.rst
> +++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst
> @@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02.
>  
>  .. literalinclude:: ../../../examples/vmdq/main.c
>      :language: c
> -    :start-after: Building correct configruration for vdmq. 8<
> +    :start-after: Building correct configuration for vdmq. 8<
>      :end-before: >8 End of get_eth_conf.
>  
>  Once the network port has been initialized using the correct VMDq values,


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

* Re: [dpdk-dev] [PATCH v1] doc: fix CI typo warnings
  2021-08-09 14:43 ` Aaron Conole
@ 2021-08-10 13:59   ` Kinsella, Ray
  0 siblings, 0 replies; 11+ messages in thread
From: Kinsella, Ray @ 2021-08-10 13:59 UTC (permalink / raw)
  To: Aaron Conole; +Cc: dev, bruce.richardson, john.mcnamara

yah - I would oblige.

Ray K

On 09/08/2021 15:43, Aaron Conole wrote:
> Ray Kinsella <mdr@ashroe.eu> writes:
> 
>> Fix documentation typos that are generating spurious CI warnings.
>>
>> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
>> ---
> 
> Looks like there are still a few errors.  Ex:
> 
> ioat: end-before not used anywhere
> 
> deprecation.rst: 'inplace' should probably be 'in place'
> deprecation.rst: 'esn' -> probably needs a way to exempt this particular
> 'word' / line, because it is a function name.  I'm surprised it is even
> considered.
> 
> Is it possible to spin a v2 with these fixes?
> 
>>  doc/guides/sample_app_ug/ioat.rst            | 2 +-
>>  doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
>> index ee0a627b06..b364be3b5d 100644
>> --- a/doc/guides/sample_app_ug/ioat.rst
>> +++ b/doc/guides/sample_app_ug/ioat.rst
>> @@ -236,7 +236,7 @@ function in order to start processing for each lcore:
>>  .. literalinclude:: ../../../examples/ioat/ioatfwd.c
>>      :language: c
>>      :start-after: Start processing for each lcore. 8<
>> -    :end-before: >8 End of starting to processfor each lcore.
>> +    :end-before: >8 End of starting to process for each lcore.
>>      :dedent: 0
>>  
>>  The function launches Rx/Tx processing functions on configured lcores
>> diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst
>> index ae1b5660df..ed28525a15 100644
>> --- a/doc/guides/sample_app_ug/vmdq_forwarding.rst
>> +++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst
>> @@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02.
>>  
>>  .. literalinclude:: ../../../examples/vmdq/main.c
>>      :language: c
>> -    :start-after: Building correct configruration for vdmq. 8<
>> +    :start-after: Building correct configuration for vdmq. 8<
>>      :end-before: >8 End of get_eth_conf.
>>  
>>  Once the network port has been initialized using the correct VMDq values,
> 

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

* [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-08-09 13:06 [dpdk-dev] [PATCH v1] doc: fix CI typo warnings Ray Kinsella
  2021-08-09 14:43 ` Aaron Conole
@ 2021-08-10 14:34 ` Ray Kinsella
  2021-08-23 15:18   ` Aaron Conole
                     ` (2 more replies)
  1 sibling, 3 replies; 11+ messages in thread
From: Ray Kinsella @ 2021-08-10 14:34 UTC (permalink / raw)
  To: dev; +Cc: bruce.richardson, john.mcnamara, aaron.conole, mdr

Fix documentation typos that are generating spurious CI warnings.

Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
---
v2:
  * Fix some additional typos pointed out by Aaron Conole

 doc/guides/rel_notes/deprecation.rst         | 4 ++--
 doc/guides/sample_app_ug/ioat.rst            | 2 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
 examples/ioat/ioatfwd.c                      | 2 +-
 examples/vmdq/main.c                         | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 76a4abfd6b..65023e39d8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -208,7 +208,7 @@ Deprecation Notices
 
 * cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
   ``dest_sgl`` to support out of place processing.
-  This field will be null for inplace processing.
+  This field will be null for in place processing.
   This change is targeted for DPDK 21.11.
 
 * cryptodev: The structure ``rte_crypto_vec`` would be updated to add
@@ -233,7 +233,7 @@ Deprecation Notices
 * security: The IPsec configuration structure
   ``struct rte_security_ipsec_xform`` will be updated with new members to allow
   SA lifetime configuration. A new structure would be introduced to replace the
-  current member, ``esn_soft_limit``.
+  current member ``esn_soft_limit``.
 
 * security: The structure ``rte_security_ipsec_xform`` will be extended with
   multiple fields: source and destination port of UDP encapsulation,
diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
index ee0a627b06..b364be3b5d 100644
--- a/doc/guides/sample_app_ug/ioat.rst
+++ b/doc/guides/sample_app_ug/ioat.rst
@@ -236,7 +236,7 @@ function in order to start processing for each lcore:
 .. literalinclude:: ../../../examples/ioat/ioatfwd.c
     :language: c
     :start-after: Start processing for each lcore. 8<
-    :end-before: >8 End of starting to processfor each lcore.
+    :end-before: >8 End of starting to process for each lcore.
     :dedent: 0
 
 The function launches Rx/Tx processing functions on configured lcores
diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst
index ae1b5660df..ed28525a15 100644
--- a/doc/guides/sample_app_ug/vmdq_forwarding.rst
+++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst
@@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02.
 
 .. literalinclude:: ../../../examples/vmdq/main.c
     :language: c
-    :start-after: Building correct configruration for vdmq. 8<
+    :start-after: Building correct configuration for vdmq. 8<
     :end-before: >8 End of get_eth_conf.
 
 Once the network port has been initialized using the correct VMDq values,
diff --git a/examples/ioat/ioatfwd.c b/examples/ioat/ioatfwd.c
index 0c413180f8..c57a8b82f0 100644
--- a/examples/ioat/ioatfwd.c
+++ b/examples/ioat/ioatfwd.c
@@ -564,7 +564,7 @@ static void start_forwarding_cores(void)
 			lcore_id);
 	}
 }
-/* >8 End of starting to processfor each lcore. */
+/* >8 End of starting to process for each lcore. */
 
 /* Display usage */
 static void
diff --git a/examples/vmdq/main.c b/examples/vmdq/main.c
index d3bc19f78e..843cf0bf1e 100644
--- a/examples/vmdq/main.c
+++ b/examples/vmdq/main.c
@@ -136,7 +136,7 @@ static struct rte_ether_addr vmdq_ports_eth_addr[RTE_MAX_ETHPORTS];
  * valid pool number
  */
 
- /* Building correct configruration for vdmq. 8< */
+ /* Building correct configuration for vdmq. 8< */
 static inline int
 get_eth_conf(struct rte_eth_conf *eth_conf, uint32_t num_pools)
 {
-- 
2.26.2


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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
@ 2021-08-23 15:18   ` Aaron Conole
  2021-08-31 15:09     ` Kinsella, Ray
  2021-10-28 13:50   ` Walsh, Conor
  2021-11-26 13:18   ` David Marchand
  2 siblings, 1 reply; 11+ messages in thread
From: Aaron Conole @ 2021-08-23 15:18 UTC (permalink / raw)
  To: Ray Kinsella; +Cc: dev, bruce.richardson, john.mcnamara, Lijuan Tu

Ray Kinsella <mdr@ashroe.eu> writes:

> Fix documentation typos that are generating spurious CI warnings.
>
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
> ---
> v2:
>   * Fix some additional typos pointed out by Aaron Conole
>
>  doc/guides/rel_notes/deprecation.rst         | 4 ++--
>  doc/guides/sample_app_ug/ioat.rst            | 2 +-
>  doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
>  examples/ioat/ioatfwd.c                      | 2 +-
>  examples/vmdq/main.c                         | 2 +-
>  5 files changed, 6 insertions(+), 6 deletions(-)
>

LGTM.  I noticed that the Intel environment flagged a sphinx in the vmdq
change, but no other environment did.

Lijuan, can you help understand why this happened?

Acked-by: Aaron Conole <aconole@redhat.com>


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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-08-23 15:18   ` Aaron Conole
@ 2021-08-31 15:09     ` Kinsella, Ray
  0 siblings, 0 replies; 11+ messages in thread
From: Kinsella, Ray @ 2021-08-31 15:09 UTC (permalink / raw)
  To: Aaron Conole; +Cc: dev, bruce.richardson, john.mcnamara, Lijuan Tu



On 23/08/2021 16:18, Aaron Conole wrote:
> Ray Kinsella <mdr@ashroe.eu> writes:
> 
>> Fix documentation typos that are generating spurious CI warnings.
>>
>> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
>> ---
>> v2:
>>   * Fix some additional typos pointed out by Aaron Conole
>>
>>  doc/guides/rel_notes/deprecation.rst         | 4 ++--
>>  doc/guides/sample_app_ug/ioat.rst            | 2 +-
>>  doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
>>  examples/ioat/ioatfwd.c                      | 2 +-
>>  examples/vmdq/main.c                         | 2 +-
>>  5 files changed, 6 insertions(+), 6 deletions(-)
>>
> 
> LGTM.  I noticed that the Intel environment flagged a sphinx in the vmdq
> change, but no other environment did.
> 
> Lijuan, can you help understand why this happened?

Need me to send again?

> Acked-by: Aaron Conole <aconole@redhat.com>
> 

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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
  2021-08-23 15:18   ` Aaron Conole
@ 2021-10-28 13:50   ` Walsh, Conor
  2021-11-26 13:18   ` David Marchand
  2 siblings, 0 replies; 11+ messages in thread
From: Walsh, Conor @ 2021-10-28 13:50 UTC (permalink / raw)
  To: Ray Kinsella, dev; +Cc: Richardson, Bruce, Mcnamara, John, aaron.conole


> From: dev <dev-bounces@dpdk.org> On Behalf Of Ray Kinsella
> Sent: Tuesday 10 August 2021 15:34
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; aaron.conole@redhat.com; mdr@ashroe.eu
> Subject: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
> 
> Fix documentation typos that are generating spurious CI warnings.
> 
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
> ---

ioatfwd.c has moved to dmafwd.c but this patch still seems to apply correctly anyway.

Reviewed-by: Conor Walsh <conor.walsh@intel.com>

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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
  2021-08-23 15:18   ` Aaron Conole
  2021-10-28 13:50   ` Walsh, Conor
@ 2021-11-26 13:18   ` David Marchand
  2021-11-26 13:34     ` David Marchand
  2 siblings, 1 reply; 11+ messages in thread
From: David Marchand @ 2021-11-26 13:18 UTC (permalink / raw)
  To: Ray Kinsella; +Cc: dev, Bruce Richardson, Mcnamara, John, aaron.conole

On Tue, Aug 10, 2021 at 4:36 PM Ray Kinsella <mdr@ashroe.eu> wrote:
>
> Fix documentation typos that are generating spurious CI warnings.

Cc: stable@dpdk.org

>
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
Acked-by: Aaron Conole <aconole@redhat.com>
Reviewed-by: Conor Walsh <conor.walsh@intel.com>


Applied, thanks.

-- 
David Marchand


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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-11-26 13:18   ` David Marchand
@ 2021-11-26 13:34     ` David Marchand
  2021-11-26 13:37       ` Kinsella, Ray
  0 siblings, 1 reply; 11+ messages in thread
From: David Marchand @ 2021-11-26 13:34 UTC (permalink / raw)
  To: Ray Kinsella; +Cc: dev, Bruce Richardson, Mcnamara, John, aaron.conole

On Fri, Nov 26, 2021 at 2:18 PM David Marchand
<david.marchand@redhat.com> wrote:
>
> On Tue, Aug 10, 2021 at 4:36 PM Ray Kinsella <mdr@ashroe.eu> wrote:
> >
> > Fix documentation typos that are generating spurious CI warnings.
>
> Cc: stable@dpdk.org

  ^^^
  Actually, no, dropped Cc.

This patch only fixes:
Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides")


-- 
David Marchand


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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-11-26 13:34     ` David Marchand
@ 2021-11-26 13:37       ` Kinsella, Ray
  2021-11-26 13:44         ` David Marchand
  0 siblings, 1 reply; 11+ messages in thread
From: Kinsella, Ray @ 2021-11-26 13:37 UTC (permalink / raw)
  To: David Marchand; +Cc: dev, Bruce Richardson, Mcnamara, John, aaron.conole



On 26/11/2021 13:34, David Marchand wrote:
> On Fri, Nov 26, 2021 at 2:18 PM David Marchand
> <david.marchand@redhat.com> wrote:
>>
>> On Tue, Aug 10, 2021 at 4:36 PM Ray Kinsella <mdr@ashroe.eu> wrote:
>>>
>>> Fix documentation typos that are generating spurious CI warnings.
>>
>> Cc: stable@dpdk.org
> 
>    ^^^
>    Actually, no, dropped Cc.
> 
> This patch only fixes:
> Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides")
> 
> 

What did I miss?

Ray K

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

* Re: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings
  2021-11-26 13:37       ` Kinsella, Ray
@ 2021-11-26 13:44         ` David Marchand
  0 siblings, 0 replies; 11+ messages in thread
From: David Marchand @ 2021-11-26 13:44 UTC (permalink / raw)
  To: Kinsella, Ray; +Cc: dev, Bruce Richardson, Mcnamara, John, aaron.conole

On Fri, Nov 26, 2021 at 2:38 PM Kinsella, Ray <mdr@ashroe.eu> wrote:
> On 26/11/2021 13:34, David Marchand wrote:
> > On Fri, Nov 26, 2021 at 2:18 PM David Marchand
> > <david.marchand@redhat.com> wrote:
> >>
> >> On Tue, Aug 10, 2021 at 4:36 PM Ray Kinsella <mdr@ashroe.eu> wrote:
> >>>
> >>> Fix documentation typos that are generating spurious CI warnings.
> >>
> >> Cc: stable@dpdk.org
> >
> >    ^^^
> >    Actually, no, dropped Cc.
> >
> > This patch only fixes:
> > Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides")
> >
> >
>
> What did I miss?

This patch was actually fixing a previous patch from Conor.


-- 
David Marchand


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

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

Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-09 13:06 [dpdk-dev] [PATCH v1] doc: fix CI typo warnings Ray Kinsella
2021-08-09 14:43 ` Aaron Conole
2021-08-10 13:59   ` Kinsella, Ray
2021-08-10 14:34 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
2021-08-23 15:18   ` Aaron Conole
2021-08-31 15:09     ` Kinsella, Ray
2021-10-28 13:50   ` Walsh, Conor
2021-11-26 13:18   ` David Marchand
2021-11-26 13:34     ` David Marchand
2021-11-26 13:37       ` Kinsella, Ray
2021-11-26 13:44         ` David Marchand

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).