Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   "C. Masloch" <pushbx@ulukai.org>
To:     linux-doc@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
        Dave Rodgman <dave.rodgman@arm.com>, Willy Tarreau <w@1wt.eu>,
        Andrew Morton <akpm@linux-foundation.org>
Subject: [PATCH 2/2] docs: lzo: fix incorrect statement about distance zero for EOS
Date:   Fri, 22 May 2020 16:10:40 +0200
Message-Id: <20200522141040.1353769-2-pushbx@ulukai.org>
In-Reply-To: <20200522141040.1353769-1-pushbx@ulukai.org>
References: <20200522141040.1353769-1-pushbx@ulukai.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

The encoded distance bits are zero, but the distance that is
calculated from this is actually equal to 16384. So correct
this statement to read that the 0001HLLL instruction means
EOS when a distance of 16384 is seen. This matches with the
description of the instruction itself later on.

Signed-off-by: C. Masloch <pushbx@ulukai.org>
---
 Documentation/lzo.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/lzo.txt b/Documentation/lzo.txt
index f839d104d..dc9e876cb 100644
--- a/Documentation/lzo.txt
+++ b/Documentation/lzo.txt
@@ -65,9 +65,9 @@ Description
   generally encoded in the last two bits of the instruction but may also be
   taken from the last two bits of an extra operand (eg: distance).
 
-  End of stream is declared when a block copy of distance 0 is seen. Only one
-  instruction may encode this distance (0001HLLL), it takes one LE16 operand
-  for the distance, thus requiring 3 bytes.
+  End of stream is declared when a block copy of distance 16384 is seen,
+  encoded in a certain instruction (0001HLLL) with the H and D bits all zero.
+  It takes one LE16 operand for the distance, thus requiring 3 bytes.
 
   .. important::
 
-- 
2.26.2