From: Nick Terrell <terrelln@fb.com>
Date: Mon, 12 Oct 2020 19:58:13 +0000 (-0700)
Subject: [zstdmt] Clarify a comment
X-Git-Tag: v1.4.7~42^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=441ce4178ff138fc827e7d49a216677fe7ac9ca8;p=thirdparty%2Fzstd.git

[zstdmt] Clarify a comment
---

diff --git a/lib/compress/zstdmt_compress.c b/lib/compress/zstdmt_compress.c
index eeb805b35..b7be2d13b 100644
--- a/lib/compress/zstdmt_compress.c
+++ b/lib/compress/zstdmt_compress.c
@@ -1787,9 +1787,9 @@ size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
     if ((input->pos < input->size) && (endOp == ZSTD_e_end)) {
         /* Can't end yet because the input is not fully consumed.
             * We are in one of these cases:
-            * - Input buffer is NULL & empty
-            * - We filled the input buffer
-            * - We hit a synchronization point
+            * - mtctx->inBuff is NULL & empty: we couldn't get an input buffer so don't create a new job.
+            * - We filled the input buffer: flush this job but don't end the frame.
+            * - We hit a synchronization point: flush this job but don't end the frame.
             */
         assert(mtctx->inBuff.filled == 0 || mtctx->inBuff.filled == mtctx->targetSectionSize || mtctx->params.rsyncable);
         endOp = ZSTD_e_flush;