From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx.tkos.co.il (guitar.tcltek.co.il [192.115.133.116]) by dpdk.org (Postfix) with ESMTP id 477E62BA8 for ; Tue, 6 Dec 2016 12:11:08 +0100 (CET) Received: from tarshish (unknown [10.0.8.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx.tkos.co.il (Postfix) with ESMTPS id 5D535440531; Tue, 6 Dec 2016 13:11:07 +0200 (IST) Date: Tue, 6 Dec 2016 13:11:06 +0200 From: Baruch Siach To: "Mcnamara, John" Cc: "dev@dpdk.org" , Olivier Matz Message-ID: <20161206111105.g6u2bjbhcgnl5kfs@tarshish> References: <824b47fc043902610646e26a8b053199620744da.1481012725.git.baruch@tkos.co.il> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: NeoMutt/20161104 (1.7.1) Subject: Re: [dpdk-dev] [PATCH v2] doc: correct description of attach to indirect mbuf X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 06 Dec 2016 11:11:08 -0000 Hi John, On Tue, Dec 06, 2016 at 11:03:18AM +0000, Mcnamara, John wrote: > > -----Original Message----- > > From: Baruch Siach [mailto:baruch@tkos.co.il] > > Sent: Tuesday, December 6, 2016 8:25 AM > > To: dev@dpdk.org > > Cc: Mcnamara, John ; Olivier Matz > > ; Baruch Siach > > Subject: [PATCH v2] doc: correct description of attach to indirect mbuf > > > > Since commit 4a96e8b652181 ("mbuf: allow to clone an indirect mbuf") > > attaching to an indirect mbuf creates a clone of that mbuf. Update the > > mbuf documentation to match. > > > > Signed-off-by: Baruch Siach > > --- > > v2: fix checkpatch issues: long commit log lines, short commit id > > --- > > doc/guides/prog_guide/mbuf_lib.rst | 3 ++- > > 1 file changed, 2 insertions(+), 1 deletion(-) > > > > diff --git a/doc/guides/prog_guide/mbuf_lib.rst > > b/doc/guides/prog_guide/mbuf_lib.rst > > index f0aa21a6d4aa..6e73fc5a834b 100644 > > --- a/doc/guides/prog_guide/mbuf_lib.rst > > +++ b/doc/guides/prog_guide/mbuf_lib.rst > > @@ -253,7 +253,8 @@ Similarly, whenever the indirect buffer is detached, > > the reference counter on th If the resulting reference counter is equal > > to 0, the direct buffer is freed since it is no longer in use. > > > > There are a few things to remember when dealing with indirect buffers. > > -First of all, it is not possible to attach an indirect buffer to another > > indirect buffer. > > +First of all, an indirect buffer is never attached to another indirect > > buffer. > > +Attempting to attach buffer A to indirect buffer B that is attached to C, > > makes rte_pktmbuf_attach() automatically attach A to C, effectively > > cloning B. > > Thanks, please keep the doc fixes coming. > > It would be better to quote the function in fixed width text like: > ``rte_pktmbuf_attach()``. None of the function names mentioned in this chapter are quoted. I can post a fix for that, but I think it should be a separate patch. baruch -- http://baruch.siach.name/blog/ ~. .~ Tk Open Systems =}------------------------------------------------ooO--U--Ooo------------{= - baruch@tkos.co.il - tel: +972.52.368.4656, http://www.tkos.co.il -