[dpdk-dev] [PATCH] examples/flow_filtering: fix example documentation

[Ori Kam]

Hi Ferruh, PSB

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit at intel.com>
> Sent: Wednesday, January 2, 2019 4:53 PM
> To: Dekel Peled <dekelp at mellanox.com>; Ori Kam <orika at mellanox.com>
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] examples/flow_filtering: fix example
> documentation
> 
> On 12/25/2018 6:30 AM, Dekel Peled wrote:
> > PSB.
> >
> >> -----Original Message-----
> >> From: Ori Kam
> >> Sent: Tuesday, December 25, 2018 5:25 AM
> >> To: Dekel Peled <dekelp at mellanox.com>
> >> Cc: dev at dpdk.org; Dekel Peled <dekelp at mellanox.com>
> >> Subject: RE: [dpdk-dev] [PATCH] examples/flow_filtering: fix example
> >> documentation
> >>
> >>
> >>
> >>> -----Original Message-----
> >>> From: dev <dev-bounces at dpdk.org> On Behalf Of Dekel Peled
> >>> Sent: Monday, December 24, 2018 12:51 PM
> >>> To: Ori Kam <orika at mellanox.com>
> >>> Cc: dev at dpdk.org; Dekel Peled <dekelp at mellanox.com>
> >>> Subject: [dpdk-dev] [PATCH] examples/flow_filtering: fix example
> >>> documentation
> >>>
> >>> Previous patch removed the VLAN item from example code.
> >>> This patch fixes the documentation accordingly.
> >>
> >> So why are you modifying the c file?
> >>
> >
> > The doc file quotes the c file, needed to modify both to align doc with code.
> > Code change includes fix of comments, and removing redundant variables
> and their initialization.
> 
> What about removing the code from doc file, it is guaranteed that it will be
> outdated again? Or perhaps just add pseudo code if required.

I Agree with you, I think it will be better to change the doc to show only the 
key lines just as in the code while the rest of the lines as pseudo code.

Do to time limitation, I will update the doc hopefully only for the 19.05 version.

So please merge the current patch. 

Thanks,
Ori