]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
clarified comment on ZSTD_p_contentSizeFlag
authorYann Collet <cyan@fb.com>
Thu, 13 Jul 2017 09:09:07 +0000 (02:09 -0700)
committerYann Collet <cyan@fb.com>
Thu, 13 Jul 2017 09:09:07 +0000 (02:09 -0700)
lib/zstd.h

index 291c6df2588a5e1735c2bfa5fa2c4aa751dacd76..a2a756dfc1cdc6f94ffd6c9fa4d73147b8419d51 100644 (file)
@@ -955,7 +955,9 @@ typedef enum {
                               * Special: value 0 means "do not change strategy". */
 
     /* frame parameters */
-    ZSTD_p_contentSizeFlag=200, /* Content size is written into frame header _whenever known_ (default:1) */
+    ZSTD_p_contentSizeFlag=200, /* Content size is written into frame header _whenever known_ (default:1)
+                              * note that content size must be known at the beginning,
+                              * it is sent using ZSTD_CCtx_setPledgedSrcSize() */
     ZSTD_p_checksumFlag,     /* A 32-bits checksum of content is written at end of frame (default:0) */
     ZSTD_p_dictIDFlag,       /* When applicable, dictID of dictionary is provided in frame header (default:1) */