From: Ori Kam <orika@mellanox.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>, Dekel Peled <dekelp@mellanox.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] examples/flow_filtering: fix example documentation
Date: Thu, 3 Jan 2019 07:40:30 +0000 [thread overview]
Message-ID: <AM4PR05MB3425673EBDEB76DA961254DBDB8D0@AM4PR05MB3425.eurprd05.prod.outlook.com> (raw)
In-Reply-To: <aae68393-c1de-3f24-6ad6-012936d62ea7@intel.com>
Hi Ferruh, PSB
> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@intel.com>
> Sent: Wednesday, January 2, 2019 4:53 PM
> To: Dekel Peled <dekelp@mellanox.com>; Ori Kam <orika@mellanox.com>
> Cc: dev@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@mellanox.com>
> >> Cc: dev@dpdk.org; Dekel Peled <dekelp@mellanox.com>
> >> Subject: RE: [dpdk-dev] [PATCH] examples/flow_filtering: fix example
> >> documentation
> >>
> >>
> >>
> >>> -----Original Message-----
> >>> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> >>> Sent: Monday, December 24, 2018 12:51 PM
> >>> To: Ori Kam <orika@mellanox.com>
> >>> Cc: dev@dpdk.org; Dekel Peled <dekelp@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
next prev parent reply other threads:[~2019-01-03 7:40 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-24 10:50 Dekel Peled
2018-12-25 3:25 ` Ori Kam
2018-12-25 6:30 ` Dekel Peled
2018-12-25 6:37 ` Ori Kam
2019-01-02 14:52 ` Ferruh Yigit
2019-01-03 7:40 ` Ori Kam [this message]
2018-12-25 7:42 ` [dpdk-dev] [PATCH v2] " Dekel Peled
2018-12-25 9:54 ` Ori Kam
2019-01-08 15:05 ` Ferruh Yigit
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=AM4PR05MB3425673EBDEB76DA961254DBDB8D0@AM4PR05MB3425.eurprd05.prod.outlook.com \
--to=orika@mellanox.com \
--cc=dekelp@mellanox.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@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).