patches for DPDK stable branches
 help / color / mirror / Atom feed
From: "Walsh, Conor" <conor.walsh@intel.com>
To: Joyce Kong <joyce.kong@arm.com>, Ori Kam <orika@nvidia.com>,
	"Mcnamara, John" <john.mcnamara@intel.com>,
	Conor Fogarty <conor.fogarty@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>, "nd@arm.com" <nd@arm.com>,
	"stable@dpdk.org" <stable@dpdk.org>
Subject: Re: [dpdk-stable] [PATCH v1] examples/flow_filtering: fix wrong comment
Date: Wed, 3 Nov 2021 09:38:48 +0000
Message-ID: <PH0PR11MB5207316ECD4430AE18DC8306FF8C9@PH0PR11MB5207.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20211103024103.2420-1-joyce.kong@arm.com>

> From: Joyce Kong <joyce.kong@arm.com>
> Sent: Wednesday 3 November 2021 02:41
> To: Ori Kam <orika@nvidia.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Walsh, Conor <conor.walsh@intel.com>;
> Conor Fogarty <conor.fogarty@intel.com>
> Cc: dev@dpdk.org; nd@arm.com; stable@dpdk.org
> Subject: [PATCH v1] examples/flow_filtering: fix wrong comment
> 
> Change the 'IPV4' level to 'ETH' level in the comment
> as it was previously misdescribed.
> 
> Fixes: 9a212dc06c7a ("doc: use code snippets in sample app guides")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Joyce Kong <joyce.kong@arm.com>
> Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
> ---
>  examples/flow_filtering/flow_blocks.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/examples/flow_filtering/flow_blocks.c
> b/examples/flow_filtering/flow_blocks.c
> index 3251ed9f8f..b168dc6e71 100644
> --- a/examples/flow_filtering/flow_blocks.c
> +++ b/examples/flow_filtering/flow_blocks.c
> @@ -75,7 +75,7 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
>  	 * ipv4 we set this level to allow all.
>  	 */
> 
> -	/* IPv4 we set this level to allow all. 8< */
> +	/* ETH we set this level to allow all. 8< */
>  	pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
>  	/* >8 End of setting the first level of the pattern. */

Hi Joyce,

This can't be applied as is, it will break the docs build as follows:
doc/guides/sample_app_ug/flow_filtering.rst:225: WARNING: start-after pattern not found: IPv4 we set this level to allow all. 8<

The comment is a tag used by the docs to locate a snippet within the code so the corresponding tag must be changed in the docs.
The following must be added to this patch:

diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst
index 11da9148ca..e8605f36f2 100644
--- a/doc/guides/sample_app_ug/flow_filtering.rst
+++ b/doc/guides/sample_app_ug/flow_filtering.rst
@@ -224,7 +224,7 @@ Setting the first level of the pattern ETH:

 .. literalinclude:: ../../../examples/flow_filtering/flow_blocks.c
     :language: c
-    :start-after: IPv4 we set this level to allow all. 8<
+    :start-after: ETH we set this level to allow all. 8<
     :end-before: >8 End of setting the first level of the pattern.
     :dedent: 1

Thanks,
Conor.

  reply	other threads:[~2021-11-03  9:38 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-03  2:41 Joyce Kong
2021-11-03  9:38 ` Walsh, Conor [this message]
2021-11-04  7:34   ` Joyce Kong
2021-11-04  9:49     ` Walsh, Conor
2021-11-04  7:32 ` [dpdk-stable] [PATCH v2] " Joyce Kong
2021-11-04  9:49   ` Walsh, Conor
2021-11-12  6:37 ` [PATCH v3] " Joyce Kong
2021-11-16 15:13   ` 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=PH0PR11MB5207316ECD4430AE18DC8306FF8C9@PH0PR11MB5207.namprd11.prod.outlook.com \
    --to=conor.walsh@intel.com \
    --cc=conor.fogarty@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=joyce.kong@arm.com \
    --cc=nd@arm.com \
    --cc=orika@nvidia.com \
    --cc=stable@dpdk.org \
    /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

patches for DPDK stable branches

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git