[v1] 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>
---
doc/guides/sample_app_ug/ioat.rst | 2 +-
doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +-
2 files changed, 2 insertions(+), 2 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>
> ---
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,
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,
>
@@ -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,