From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-yw0-f196.google.com (mail-yw0-f196.google.com [209.85.161.196]) by dpdk.org (Postfix) with ESMTP id 165E45686 for ; Mon, 23 May 2016 18:45:43 +0200 (CEST) Received: by mail-yw0-f196.google.com with SMTP id u62so24132973ywe.3 for ; Mon, 23 May 2016 09:45:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc; bh=RcR8oH5T9KZVHV7iqHtKUCfM5XOJ6GiDhZwTzMQJXMA=; b=WBiqVoGSMuVBhzE6BLcYzIjsBihTx3GPD+x1bDeHTMsSCdV3qws1apT6oiWIlAloCA affwU4NfHnb2ZDqcmMbYbMtGtIJqLDWYnm2EQgut4QELONUFt635ioSjPRpW1Ac85w83 5jMjjJmuBWWOQfgGfUZNiahoih7xRlP/JDLjFMWqJkqyOCJun9xSa3IdynAb409pmX53 4Br5SKpH/oLeGI4o7Vn4mXM4bWLPOxlKh/rX4ip/TsL7DywUX/NUx1C8A1pXdStxy2p1 pYpBPn/9IyD2U3b+aahy8eQWg/6sGfEk5NmJUFmmd/YfF5caZGeZX/eYS0lpYzexViCZ Uhlw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc; bh=RcR8oH5T9KZVHV7iqHtKUCfM5XOJ6GiDhZwTzMQJXMA=; b=C/GnZL4SL4CET0Ui8M0xWwbRLE+jV+mo6ts0BBd0+Zrd2+ULzzHddX26wn0jnWwn7i 4+eGayNinfcVHQv6SZ6RyGpbnPkMOHhV5oG5ZXATgahyEKJ2/1AVMgiTvnufMPLpC57E lAwTdZxhpl5hZleT4ylU2biAwUWHb7+Vp5rBetOLKr9KNqKOcl0B6TVy7qZ3+kUR/JnA fy0XVDzDAxzm73DxF1gACnOgRTb7KgOe5Jzo6F1M0cSBbwVMdqe/n8jkxn12GKhj0JaE 0UIWocm30EoGnP8K/wJ9ubgN28T+KwUzzrfpJdpx+ZQP87Fb/0qV48K/o63RElYm46an 4Kcg== X-Gm-Message-State: AOPr4FWvgWNU/KDmO9SU5l9ox3uetJwh7IqLmacnXEExU9prGjAHA3oonmjD5i4t/H7DKWSW/JfkDV3ZPTOUIQ== MIME-Version: 1.0 X-Received: by 10.129.110.196 with SMTP id j187mr10878037ywc.209.1464021942462; Mon, 23 May 2016 09:45:42 -0700 (PDT) Received: by 10.129.70.11 with HTTP; Mon, 23 May 2016 09:45:42 -0700 (PDT) In-Reply-To: <573C44E8.2030908@intel.com> References: <1463250175-3024-1-git-send-email-ee07b291@gmail.com> <573C44E8.2030908@intel.com> Date: Mon, 23 May 2016 09:45:42 -0700 Message-ID: From: ALeX Wang To: Ferruh Yigit Cc: dev@dpdk.org, Alex Wang Content-Type: text/plain; charset=UTF-8 X-Content-Filtered-By: Mailman/MimeDel 2.1.15 Subject: Re: [dpdk-dev] [PATCH 1/2] rte_kni: Fix documentation. X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 23 May 2016 16:45:43 -0000 Sorry for the delayed reply, just sent V2~ On 18 May 2016 at 03:33, Ferruh Yigit wrote: > On 5/14/2016 7:22 PM, Alex Wang wrote: > > From: Alex Wang > > > > The 'mbufs' alloc/free descriptions for 'rte_kni_tx_burst()' > > and 'rte_kni_rx_burst()' should be inverted. > > > > Signed-off-by: Alex Wang > > --- > > 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