Skip to contentSkip to conversation

doc: fix CI typo warnings

PATCH Superseded Ray Kinsella 4 participants 11 messages Aug 9, 2021 – Nov 26, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fix CI typo warnings

Fix documentation typos that are generating spurious CI warnings.

---
 doc/guides/sample_app_ug/ioat.rst            | 2 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
doc/guides/sample_app_ug/ioat.rst +1 -1
index ee0a627b06..b364be3b5d 100644
@@ -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
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
index ae1b5660df..ed28525a15 100644
@@ -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,
Signature · 1 line
2.26.2
#1 lore raw
Quoted 4 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

---

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?

Quoted 30 lines
 doc/guides/sample_app_ug/ioat.rst            | 2 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
doc/guides/sample_app_ug/ioat.rst +1 -1
index ee0a627b06..b364be3b5d 100644
@@ -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
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
index ae1b5660df..ed28525a15 100644
@@ -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 lore raw

yah - I would oblige.

Ray K

Quoted 49 lines · Aaron Conole
Quoted 4 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

---

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?

Quoted 30 lines
 doc/guides/sample_app_ug/ioat.rst            | 2 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
doc/guides/sample_app_ug/ioat.rst +1 -1
index ee0a627b06..b364be3b5d 100644
@@ -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
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
index ae1b5660df..ed28525a15 100644
@@ -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,
#3 lore raw

PATCH v2 1/1 doc: fix CI typo warnings

In reply to Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

---
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(-)
doc/guides/rel_notes/deprecation.rst +2 -2
index 76a4abfd6b..65023e39d8 100644
@@ -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,
doc/guides/sample_app_ug/ioat.rst +1 -1
index ee0a627b06..b364be3b5d 100644
@@ -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
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
index ae1b5660df..ed28525a15 100644
@@ -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,
examples/ioat/ioatfwd.c +1 -1
index 0c413180f8..c57a8b82f0 100644
@@ -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
examples/vmdq/main.c +1 -1
index d3bc19f78e..843cf0bf1e 100644
@@ -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)
 {
Signature · 1 line
2.26.2
Acked-by on v2 1/1
#4 lore raw
Quoted 7 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

---
v2:
* Fix some additional typos pointed out by Aaron Conole

Quoted 7 lines
 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?

#5 lore raw
Quoted 17 lines · Aaron Conole
Quoted 7 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

---
v2:
* Fix some additional typos pointed out by Aaron Conole

Quoted 7 lines
 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(-)
Quoted 4 lines

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?

Quoted 2 lines
Reviewed-by on v2 1/1
#6 lore raw
In reply to Ray Kinsella
Quoted 8 lines

From: dev <[email protected]> On Behalf Of Ray Kinsella
Sent: Tuesday 10 August 2021 15:34
To: [email protected]
Cc: Richardson, Bruce <[email protected]>; Mcnamara, John <[email protected]>; [email protected]; [email protected]
Subject: [dpdk-dev] [PATCH v2] doc: fix CI typo warnings

Quoted 4 lines

Fix documentation typos that are generating spurious CI warnings.

---

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

#8 lore raw
Quoted 6 lines · David Marchand
Quoted 2 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

^^^
Actually, no, dropped Cc.

This patch only fixes:

Fixes 9a212dc06c7a ("doc: use code snippets in sample app guides")
Signature · 1 line
David Marchand
#9 lore raw
Quoted 7 lines · David Marchand
Quoted 5 lines · David Marchand
Quoted 2 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

Quoted 9 lines
Quoted 1 line

^^^
Actually, no, dropped Cc.

This patch only fixes:

Fixes 9a212dc06c7a ("doc: use code snippets in sample app guides")

What did I miss?

Ray K

#10 lore raw
Quoted 13 lines · Ray
Quoted 12 lines · David Marchand
Quoted 6 lines · David Marchand
Quoted 2 lines · Ray Kinsella

Fix documentation typos that are generating spurious CI warnings.

^^^
Actually, no, dropped Cc.

Quoted 6 lines
Quoted 4 lines

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.

Signature · 1 line
David Marchand