diff mbox

[dpdk-dev,v2] mbuf: fix mbuf bulk alloc Doxygen

Message ID 20170726042005.7897-1-pablo.de.lara.guarch@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

De Lara Guarch, Pablo July 26, 2017, 4:20 a.m. UTC 
  When calling rte_pktmbuf_alloc_bulk, if there are
not enough objects in the mempool, it returns
a negative value, which should be reflected
in the Doxygen comments.

Fixes: 9ec201f5d6e7 ("mbuf: provide bulk allocation")
Cc: stable@dpdk.org

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---

Changes in v2:
- CC stable

 lib/librte_mbuf/rte_mbuf.h | 1 +
 1 file changed, 1 insertion(+)

Comments

Thomas Monjalon July 31, 2017, 3:17 p.m. UTC | #1 
26/07/2017 06:20, Pablo de Lara:
> When calling rte_pktmbuf_alloc_bulk, if there are
> not enough objects in the mempool, it returns
> a negative value, which should be reflected
> in the Doxygen comments.
> 
> Fixes: 9ec201f5d6e7 ("mbuf: provide bulk allocation")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks
diff mbox

Patch

diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 55206d9..eaed7ee 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -1138,6 +1138,7 @@  static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
  *    Array size
  *  @return
  *   - 0: Success
+ *   - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
  */
 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
 	 struct rte_mbuf **mbufs, unsigned count)