[v2] doc: fix CI typo warnings
Checks
Commit Message
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
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>
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>
>
> 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>
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.
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")
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
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.
@@ -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,
@@ -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
@@ -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,
@@ -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
@@ -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)
{