mbuf: fix doxygen comment of bulk alloc
authorPablo de Lara <pablo.de.lara.guarch@intel.com>
Wed, 26 Jul 2017 04:20:05 +0000 (05:20 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 31 Jul 2017 15:17:25 +0000 (17:17 +0200)
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>
lib/librte_mbuf/rte_mbuf.h

index 55206d9..eaed7ee 100644 (file)
@@ -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)