DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Yigit, Ferruh" <ferruh.yigit@intel.com>,
	"Zhao1, Wei" <wei.zhao1@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "stable@dpdk.org" <stable@dpdk.org>,
	"orika@mellanox.com" <orika@mellanox.com>
Subject: Re: [dpdk-dev] [PATCH v3] doc: update flow filtering document
Date: Mon, 5 Feb 2018 15:31:09 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EEA75F2@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <37e0c4ff-3370-27d7-fe03-6889b5f4c35c@intel.com>


> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Wednesday, January 31, 2018 5:24 PM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; stable@dpdk.org;
> orika@mellanox.com
> Subject: Re: [dpdk-dev] [PATCH v3] doc: update flow filtering document
> 
> On 1/31/2018 2:12 AM, Wei Zhao wrote:
> > This patch will update example application of flow_filtering document.
> > It add Tx queues configuration related comment.
> >
> > Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
> > Reviewed-by: Ori Kam <orika@mellanox.com>
> 
> Hi Wei,
> 
> This patch is causing documentation warning:
> ...dpdk/doc/guides/sample_app_ug/flow_filtering.rst:161: WARNING: Could
> not lex literal_block as "c". Highlighting skipped.

Hi,

The reason for the warning was due to 2 instances like the following:

+                            rte_exit(EXIT_FAILURE,
+                                    ":: Rx queue setup failed: err=%d,
+                                    port=%u\n",
+                                    ret, port_id);
                    

Here the error string extends over 2 lines so the error message will print out a newline and a lot of whitespace in the middle of the string. It should probably
be something like the following:

+                            rte_exit(EXIT_FAILURE,
+                                    ":: Rx queue setup failed: err=%d, "
+                                    "port=%u\n",
+                                    ret, port_id);
                    
or just:

+                            rte_exit(EXIT_FAILURE,
+                                    ":: Rx queue setup failed: err=%d, port=%u\n",
+                                    ret, port_id);

We can fix the code in the doc but you should probably fix this in the code as well.

John

  reply	other threads:[~2018-02-05 15:31 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-30  7:32 [dpdk-dev] [PATCH] doc: update flow filting document Wei Zhao
2018-01-30  7:44 ` [dpdk-dev] [PATCH v2] " Wei Zhao
2018-01-30  9:22   ` Ori Kam
2018-01-31  2:22     ` Zhao1, Wei
2018-01-31  2:12   ` [dpdk-dev] [PATCH v3] doc: update flow filtering document Wei Zhao
2018-01-31  6:50     ` Zhang, Helin
2018-01-31 17:24     ` Ferruh Yigit
2018-02-05 15:31       ` Mcnamara, John [this message]
2018-02-06 14:18         ` Ferruh Yigit
2018-02-07  8:07           ` Zhao1, Wei
2018-02-07  7:37         ` Zhao1, Wei

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=B27915DBBA3421428155699D51E4CFE23EEA75F2@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=orika@mellanox.com \
    --cc=stable@dpdk.org \
    --cc=wei.zhao1@intel.com \
    /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).