From: ALeX Wang <ee07b291@gmail.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: dev@dpdk.org, Alex Wang <alex@awakenetworks.com>
Subject: Re: [dpdk-dev] [PATCH 1/2] rte_kni: Fix documentation.
Date: Mon, 23 May 2016 09:45:42 -0700 [thread overview]
Message-ID: <CANmyKO4W=8bUTZPTLExQQi=RsSnT1vk4DCLEJxx+DbBK=5TuJQ@mail.gmail.com> (raw)
In-Reply-To: <573C44E8.2030908@intel.com>
Sorry for the delayed reply, just sent V2~
On 18 May 2016 at 03:33, Ferruh Yigit <ferruh.yigit@intel.com> wrote:
> On 5/14/2016 7:22 PM, Alex Wang wrote:
> > From: Alex Wang <alex@awakenetworks.com>
> >
> > The 'mbufs' alloc/free descriptions for 'rte_kni_tx_burst()'
> > and 'rte_kni_rx_burst()' should be inverted.
> >
> > Signed-off-by: Alex Wang <alex@awakenetworks.com>
> > ---
> > lib/librte_kni/rte_kni.h | 8 ++++----
> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >
> > diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h
> > index ef9faa9..25fa45e 100644
> > --- a/lib/librte_kni/rte_kni.h
> > +++ b/lib/librte_kni/rte_kni.h
> > @@ -161,8 +161,8 @@ extern int rte_kni_handle_request(struct rte_kni
> *kni);
> > /**
> > * Retrieve a burst of packets from a KNI interface. The retrieved
> packets are
> > * stored in rte_mbuf structures whose pointers are supplied in the
> array of
> > - * mbufs, and the maximum number is indicated by num. It handles the
> freeing of
> > - * the mbufs in the free queue of KNI interface.
> > + * mbufs, and the maximum number is indicated by num. It handles
> allocating
> > + * the mbufs for KNI interface alloc queue.
> > *
> > * @param kni
> > * The KNI interface context.
> > @@ -180,8 +180,8 @@ extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
> > /**
> > * Send a burst of packets to a KNI interface. The packets to be sent
> out are
> > * stored in rte_mbuf structures whose pointers are supplied in the
> array of
> > - * mbufs, and the maximum number is indicated by num. It handles
> allocating
> > - * the mbufs for KNI interface alloc queue.
> > + * mbufs, and the maximum number is indicated by num. It handles the
> freeing of
> > + * the mbufs in the free queue of KNI interface.
> > *
> > * @param kni
> > * The KNI interface context.
> >
>
> Hi Alex,
>
> Can you please update the patch subject,
> - replace "rte_kni" tag with a "kni",
> - after space start with lowercase,
> - remove the "." at the end of the sentences,
> like:
> "kni: fix documentation"
> (these are defined in
>
> http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-subject-line
> )
>
> Also can you please add a "Fixes" line, more details on:
> http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-body
>
> Although this information converted into documentation, this is not
> really the documentation, and the patch title gives little information,
> if possible can you please add more information while keeping it around
> 50 chars limit.
>
> finally, patch content is OK.
>
> Thanks,
> ferruh
>
>
--
Alex Wang,
Open vSwitch developer
prev parent reply other threads:[~2016-05-23 16:45 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-14 18:22 Alex Wang
2016-05-14 18:22 ` [dpdk-dev] [PATCH 2/2] rte_kni: Add documentation for the mempool capacity Alex Wang
2016-05-18 10:38 ` Ferruh Yigit
2016-05-18 10:33 ` [dpdk-dev] [PATCH 1/2] rte_kni: Fix documentation Ferruh Yigit
2016-05-23 16:45 ` ALeX Wang [this message]
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='CANmyKO4W=8bUTZPTLExQQi=RsSnT1vk4DCLEJxx+DbBK=5TuJQ@mail.gmail.com' \
--to=ee07b291@gmail.com \
--cc=alex@awakenetworks.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).