[dpdk-dev] [PATCH v2] doc: correct description of attach to indirect mbuf

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch at tkos.co.il]
> Sent: Tuesday, December 6, 2016 8:25 AM
> To: dev at dpdk.org
> Cc: Mcnamara, John <john.mcnamara at intel.com>; Olivier Matz
> <olivier.matz at 6wind.com>; Baruch Siach <baruch at tkos.co.il>
> 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 <baruch at tkos.co.il>
> ---
> 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()``.