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

Ferruh Yigit ferruh.yigit at intel.com
Wed Jan 2 15:52:42 CET 2019


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.



More information about the dev mailing list