From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id CB47A2BB3 for ; Tue, 6 Dec 2016 12:03:21 +0100 (CET) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga105.fm.intel.com with ESMTP; 06 Dec 2016 03:03:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,309,1477983600"; d="scan'208";a="39470183" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by fmsmga006.fm.intel.com with ESMTP; 06 Dec 2016 03:03:19 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.91]) by IRSMSX154.ger.corp.intel.com ([169.254.12.108]) with mapi id 14.03.0248.002; Tue, 6 Dec 2016 11:03:19 +0000 From: "Mcnamara, John" To: Baruch Siach , "dev@dpdk.org" CC: Olivier Matz Thread-Topic: [PATCH v2] doc: correct description of attach to indirect mbuf Thread-Index: AQHST5po2A48DS+3rUCWzo0+uW3E6aD6uojw Date: Tue, 6 Dec 2016 11:03:18 +0000 Message-ID: References: <824b47fc043902610646e26a8b053199620744da.1481012725.git.baruch@tkos.co.il> In-Reply-To: <824b47fc043902610646e26a8b053199620744da.1481012725.git.baruch@tkos.co.il> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_PUBLIC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiOGNlMDU1NWMtNzNiMS00NzEwLWExZjgtNGQ0ZTdmNGZjY2U0IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX1BVQkxJQyJ9XX1dfSwiU3ViamVjdExhYmVscyI6W10sIlRNQ1ZlcnNpb24iOiIxNS45LjYuNiIsIlRydXN0ZWRMYWJlbEhhc2giOiJTbGRPYUxOd1lwYUtJNDlpUEMrelN0RDdJOFFIYUJcL2U2UVkyRzB4NkhjYz0ifQ== x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 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:03:22 -0000 > -----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 >=20 > 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. >=20 > 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(-) >=20 > 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. >=20 > 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_pk= tmbuf_attach()``.