diff mbox series

[v2] doc: fix CI typo warnings

Message ID 20210810143420.990875-1-mdr@ashroe.eu (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers show
Series [v2] doc: fix CI typo warnings | expand

Checks

Context Check Description
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/github-robot-build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/Intel-compilation fail Compilation issues
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-spell-check-testing success Testing PASS
ci/checkpatch success coding style OK

Commit Message

Kinsella, Ray Aug. 10, 2021, 2:34 p.m. UTC
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(-)

Comments

Aaron Conole Aug. 23, 2021, 3:18 p.m. UTC | #1
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>
Kinsella, Ray Aug. 31, 2021, 3:09 p.m. UTC | #2
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>
>
diff mbox series

Patch

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