DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Ori Kam <orika@mellanox.com>,
	"adrien.mazarguil@6wind.com" <adrien.mazarguil@6wind.com>,
	"thomas@monjalon.net" <thomas@monjalon.net>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 2/2] doc: add flow_filtering example documentation
Date: Fri, 20 Oct 2017 16:33:12 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDDF58B@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1508408167-9001-1-git-send-email-orika@mellanox.com>



> -----Original Message-----
> From: Ori Kam [mailto:orika@mellanox.com]
> Sent: Thursday, October 19, 2017 11:16 AM
> To: adrien.mazarguil@6wind.com; Mcnamara, John <john.mcnamara@intel.com>;
> thomas@monjalon.net
> Cc: dev@dpdk.org; orika@mellanox.com
> Subject: [PATCH 2/2] doc: add flow_filtering example documentation
> 
> Signed-off-by: Ori Kam <orika@mellanox.com>

Hi,

1. This file needs to be included in the index.rst file.
2. There is a doc compilation issue due to a missing blank line after one of the code-block sections.
3. There is a white space warning on merge.

Apart from that the doc looks good.

Below are the changes I made to get it to compile.

John

$ git diff
diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst
index b8d59af..f2d7db2 100644
--- a/doc/guides/sample_app_ug/flow_filtering.rst
+++ b/doc/guides/sample_app_ug/flow_filtering.rst
@@ -113,7 +113,8 @@ The ``main()`` also allocates a mempool to hold the mbufs (Message Buffers)
 used by the application:
 
 .. code-block:: c
-   mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", 4096, 128, 0,
+
+    mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", 4096, 128, 0,
                                             RTE_MBUF_DEFAULT_BUF_SIZE,
                                             rte_socket_id());
 
@@ -536,4 +537,3 @@ The last part of the function is to validate the rule and create it.
    int res = rte_flow_validate(port_id, &attr, pattern, action, &error);
    if (!res)
         flow = rte_flow_create(port_id, &attr, pattern, action, &error);
-
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index 069d4f1..ca1f544 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -77,6 +77,7 @@ Sample Applications User Guides
     ptpclient
     performance_thread
     ipsec_secgw
+    flow_filtering
 
 **Figures**

  reply	other threads:[~2017-10-20 16:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-19 10:16 Ori Kam
2017-10-20 16:33 ` Mcnamara, John [this message]
2017-10-21  7:20   ` Ori Kam

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=B27915DBBA3421428155699D51E4CFE23EDDF58B@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=adrien.mazarguil@6wind.com \
    --cc=dev@dpdk.org \
    --cc=orika@mellanox.com \
    --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).