mempool: enhance flags documentation readability
authorAndrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Tue, 19 Oct 2021 17:40:17 +0000 (20:40 +0300)
committerDavid Marchand <david.marchand@redhat.com>
Wed, 20 Oct 2021 07:58:39 +0000 (09:58 +0200)
Move documentation into a separate line just before define.
Prepare to have a bit longer flag name because of namespace prefix.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
lib/mempool/rte_mempool.h

index b2e20c8..ee27f79 100644 (file)
@@ -250,13 +250,18 @@ struct rte_mempool {
 #endif
 }  __rte_cache_aligned;
 
+/** Spreading among memory channels not required. */
 #define MEMPOOL_F_NO_SPREAD      0x0001
-               /**< Spreading among memory channels not required. */
-#define MEMPOOL_F_NO_CACHE_ALIGN 0x0002 /**< Do not align objs on cache lines.*/
-#define MEMPOOL_F_SP_PUT         0x0004 /**< Default put is "single-producer".*/
-#define MEMPOOL_F_SC_GET         0x0008 /**< Default get is "single-consumer".*/
-#define MEMPOOL_F_POOL_CREATED   0x0010 /**< Internal: pool is created. */
-#define MEMPOOL_F_NO_IOVA_CONTIG 0x0020 /**< Don't need IOVA contiguous objs. */
+/** Do not align objects on cache lines. */
+#define MEMPOOL_F_NO_CACHE_ALIGN 0x0002
+/** Default put is "single-producer". */
+#define MEMPOOL_F_SP_PUT         0x0004
+/** Default get is "single-consumer". */
+#define MEMPOOL_F_SC_GET         0x0008
+/** Internal: pool is created. */
+#define MEMPOOL_F_POOL_CREATED   0x0010
+/** Don't need IOVA contiguous objects. */
+#define MEMPOOL_F_NO_IOVA_CONTIG 0x0020
 /** Internal: no object from the pool can be used for device IO (DMA). */
 #define MEMPOOL_F_NON_IO         0x0040