DPDK patches and discussions
 help / color / mirror / Atom feed
From: Baruch Siach <baruch@tkos.co.il>
To: dev@dpdk.org
Cc: John McNamara <john.mcnamara@intel.com>,
	Olivier Matz <olivier.matz@6wind.com>,
	Baruch Siach <baruch@tkos.co.il>
Subject: [dpdk-dev] [PATCH] doc: correct description of attach to indirect mbuf
Date: Tue,  6 Dec 2016 10:15:55 +0200	[thread overview]
Message-ID: <f4057510c794c0e18d1677eda7e3cbf18e3de530.1481012155.git.baruch@tkos.co.il> (raw)

Since commit 4a96e8b652 ("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@tkos.co.il>
---
 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.
 Secondly, for a buffer to become indirect, its reference counter must be equal to 1,
 that is, it must not be already referenced by another indirect buffer.
 Finally, it is not possible to reattach an indirect buffer to the direct buffer (unless it is detached first).
-- 
2.10.2

                 reply	other threads:[~2016-12-06  8:16 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=f4057510c794c0e18d1677eda7e3cbf18e3de530.1481012155.git.baruch@tkos.co.il \
    --to=baruch@tkos.co.il \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=olivier.matz@6wind.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).