X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_compressdev%2Frte_comp.h;h=95306c5d036494f740b3225be2c206d6dc99bb5c;hb=a8cdfc69c84b7740646368a46bbd3d4d6ddf97b0;hp=b7474c49b65849b10815663680c307bb06810728;hpb=18218713bf4248c4c6b97a12231e7d59b8a86865;p=dpdk.git

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index b7474c49b6..95306c5d03 100644
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -323,6 +323,12 @@ struct rte_comp_op {
 	 * 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 {