DPDK patches and discussions
 help / color / mirror / Atom feed
From: Aaron Conole <aconole@redhat.com>
To: Ray Kinsella <mdr@ashroe.eu>
Cc: dev@dpdk.org,  bruce.richardson@intel.com,  john.mcnamara@intel.com
Subject: Re: [dpdk-dev] [PATCH v1] doc: fix CI typo warnings
Date: Mon, 09 Aug 2021 10:43:39 -0400	[thread overview]
Message-ID: <f7tk0kud6g4.fsf@redhat.com> (raw)
In-Reply-To: <20210809130601.930651-1-mdr@ashroe.eu> (Ray Kinsella's message of "Mon, 9 Aug 2021 14:06:01 +0100")

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,


  reply	other threads:[~2021-08-09 14:43 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-09 13:06 Ray Kinsella
2021-08-09 14:43 ` Aaron Conole [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f7tk0kud6g4.fsf@redhat.com \
    --to=aconole@redhat.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=mdr@ashroe.eu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).