From: Yann Collet <cyan@fb.com>
Date: Wed, 11 Dec 2024 00:17:41 +0000 (-0800)
Subject: doc: add mention of frame checksum incompatibility
X-Git-Tag: v1.5.7^2~48^2~47
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e0f3aaee467bbcb7e1653756eb426a9b7adde5d8;p=thirdparty%2Fzstd.git

doc: add mention of frame checksum incompatibility

for new prototype ZSTD_compressSequencesAndLiterals()
---

diff --git a/lib/zstd.h b/lib/zstd.h
index 94058a1b2..b3c82e174 100644
--- a/lib/zstd.h
+++ b/lib/zstd.h
@@ -1660,10 +1660,11 @@ ZSTD_compressSequences( ZSTD_CCtx* cctx, void* dst, size_t dstSize,
 /*! ZSTD_compressSequencesAndLiterals() :
  * This is a variant of ZSTD_compressSequences() which,
  * instead of receiving (src,srcSize) as input parameter, receives (literals,litSize),
- * aka all literals already extracted and grouped into a single continuous buffer.
+ * aka all literals already extracted and laid out into a single continuous buffer.
  * This can be useful if the process generating the sequences also happens to generate the buffer of literals,
  * thus skipping an extraction + caching stage.
- * To be valid, `litSize` must be equal to the sum of all @.litLength fields in @inSeqs.
+ * To be valid, @litSize must be equal to the sum of all @.litLength fields in @inSeqs.
+ * Important: Employing this prototype is incompatible with frame checksum.
  * @return : final compressed size, or a ZSTD error code.
  */
 ZSTDLIB_STATIC_API size_t