doc: add patch dependency syntax to contributing guide

[dpdk.git] / lib / librte_compressdev / rte_comp.h

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index c2b3de8..95306c5 100644 (file)
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -310,7 +310,7 @@ struct rte_comp_op {
        struct rte_mbuf *m_src;
        /**< source mbuf
         * The total size of the input buffer(s) can be retrieved using
-        * rte_pktmbuf_data_len(m_src). The max data size which can fit in a
+        * rte_pktmbuf_pkt_len(m_src). The max data size which can fit in a
         * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
         * If the input data is bigger than this it can be passed to the PMD in
         * a chain of mbufs if the PMD's capabilities indicate it supports this.
@@ -318,11 +318,17 @@ struct rte_comp_op {
        struct rte_mbuf *m_dst;
        /**< destination mbuf
         * The total size of the output buffer(s) can be retrieved using
-        * rte_pktmbuf_data_len(m_dst). The max data size which can fit in a
+        * rte_pktmbuf_pkt_len(m_dst). The max data size which can fit in a
         * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
         * If the output data is expected to be bigger than this a chain of
         * mbufs can be passed to the PMD if the PMD's capabilities indicate
         * it supports this.
+        *
+        * @note, if incompressible data is passed to an engine for compression
+        * using RTE_COMP_ALGO_DEFLATE, it's possible for the output data
+        * to be larger than the uncompressed data, due to the inclusion
+        * of the DEFLATE header blocks. The size of m_dst should accommodate
+        * this, else OUT_OF_SPACE errors can be expected in this case.
         */
 
        struct {
@@ -420,7 +426,8 @@ struct rte_comp_op {
  *  - On success pointer to mempool
  *  - On failure NULL
  */
-struct rte_mempool * __rte_experimental
+__rte_experimental
+struct rte_mempool *
 rte_comp_op_pool_create(const char *name,
                unsigned int nb_elts, unsigned int cache_size,
                uint16_t user_size, int socket_id);
@@ -435,7 +442,8 @@ rte_comp_op_pool_create(const char *name,
  * - On success returns a valid rte_comp_op structure
  * - On failure returns NULL
  */
-struct rte_comp_op * __rte_experimental
+__rte_experimental
+struct rte_comp_op *
 rte_comp_op_alloc(struct rte_mempool *mempool);
 
 /**
@@ -451,7 +459,8 @@ rte_comp_op_alloc(struct rte_mempool *mempool);
  *   - nb_ops: Success, the nb_ops requested was allocated
  *   - 0: Not enough entries in the mempool; no ops are retrieved.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_comp_op_bulk_alloc(struct rte_mempool *mempool,
                struct rte_comp_op **ops, uint16_t nb_ops);
 
@@ -463,7 +472,8 @@ rte_comp_op_bulk_alloc(struct rte_mempool *mempool,
  * @param op
  *   Compress operation
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_comp_op_free(struct rte_comp_op *op);
 
 /**
@@ -477,7 +487,8 @@ rte_comp_op_free(struct rte_comp_op *op);
  * @param nb_ops
  *   Number of operations to free
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops);
 
 /**
@@ -489,7 +500,8 @@ rte_comp_op_bulk_free(struct rte_comp_op **ops, uint16_t nb_ops);
  * @return
  *   The name of this flag, or NULL if it's not a valid feature flag.
  */
-const char * __rte_experimental
+__rte_experimental
+const char *
 rte_comp_get_feature_name(uint64_t flag);
 
 #ifdef __cplusplus