DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Walsh, Conor" <conor.walsh@intel.com>
To: Henry Nadeau <hnadeau@iol.unh.edu>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "thomas@monjalon.net" <thomas@monjalon.net>
Subject: Re: [dpdk-dev] [PATCH] doc: two typos in documentation
Date: Thu, 28 Oct 2021 13:10:40 +0000	[thread overview]
Message-ID: <PH0PR11MB5207CEE2AD8454370A9E9B85FF869@PH0PR11MB5207.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20210804182651.7790-1-hnadeau@iol.unh.edu>

Hi Henry,

When correcting these tags the corresponding tags within the code must also be updated to match
or it will break the literalinclude link and cause the warnings shown below.

doc/guides/sample_app_ug/dma.rst:240: WARNING: end-before pattern not found: >8 End of starting to process for each lcore.
doc/guides/sample_app_ug/vmdq_forwarding.rst:104: WARNING: start-after pattern not found: Building correct configuration for vdmq. 8<

Thanks,
Conor.

> From: dev <dev-bounces@dpdk.org> On Behalf Of Henry Nadeau
> Sent: Wednesday 4 August 2021 19:27
> To: dev@dpdk.org
> Cc: thomas@monjalon.net
> Subject: [dpdk-dev] [PATCH] doc: two typos in documentation
> 
> Corrected two typos that got added in the most recent merge.
> 
> 
> Signed-off-by: Henry Nadeau <hnadeau@iol.unh.edu>
> ---
>  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.

This one is within ../../../examples/ioat/ioatfwd.c now ../../../examples/dma/dmafwd.c

>      :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<

And this one is within ../../../examples/vmdq/main.c

>      :end-before: >8 End of get_eth_conf.
> 
>  Once the network port has been initialized using the correct VMDq values,
> --
> 2.25.1

      parent reply	other threads:[~2021-10-28 13:11 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-04 18:26 Henry Nadeau
2021-08-05  7:52 ` Thomas Monjalon
2021-10-28 13:10 ` Walsh, Conor [this message]

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=PH0PR11MB5207CEE2AD8454370A9E9B85FF869@PH0PR11MB5207.namprd11.prod.outlook.com \
    --to=conor.walsh@intel.com \
    --cc=dev@dpdk.org \
    --cc=hnadeau@iol.unh.edu \
    --cc=thomas@monjalon.net \
    /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).