[dpdk-dev] [PATCH v3] doc: update flow filtering document

Mcnamara, John john.mcnamara at intel.com
Mon Feb 5 16:31:09 CET 2018


> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Wednesday, January 31, 2018 5:24 PM
> To: Zhao1, Wei <wei.zhao1 at intel.com>; dev at dpdk.org
> Cc: Mcnamara, John <john.mcnamara at intel.com>; stable at dpdk.org;
> orika at 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 at intel.com>
> > Reviewed-by: Ori Kam <orika at 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


More information about the dev mailing list