From 610171ed86b947431796ec58854a673c674f6602 Mon Sep 17 00:00:00 2001
From: Nick Terrell <terrelln@fb.com>
Date: Wed, 4 Mar 2020 16:29:19 -0800
Subject: [PATCH] [opt] Explain why we don't include literals price

---
 lib/compress/zstd_opt.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/compress/zstd_opt.c b/lib/compress/zstd_opt.c
index 44a13ddb7..896365fc8 100644
--- a/lib/compress/zstd_opt.c
+++ b/lib/compress/zstd_opt.c
@@ -881,6 +881,11 @@ ZSTD_compressBlock_opt_generic(ZSTD_matchState_t* ms,
             { U32 i ; for (i=0; i<ZSTD_REP_NUM; i++) opt[0].rep[i] = rep[i]; }
             opt[0].mlen = 0;  /* means is_a_literal */
             opt[0].litlen = litlen;
+            /* We don't need to include the actual price of the literals because
+             * it is static for the duration of the forward pass, and is included
+             * in every price. We include the literal length to avoid negative
+             * prices when we subtract the previous literal length.
+             */
             opt[0].price = ZSTD_litLengthPrice(litlen, optStatePtr, optLevel);
 
             /* large match -> immediate encoding */