Infelicity in manual bundled with bzip2 1.0.9

Infelicity in manual bundled with bzip2 1.0.9

[Vanessa McHale]

[-- Attachment #1.1: Type: text/plain, Size: 393 bytes --]

Hello all,

According to the PDF manual (page 17), BZ2_bzDecompress can return one
of BZ_PARAM_ERROR, BZ_DATA_ERROR, BZ_DATA_ERROR_MAGIC, BZ_MEM_ERROR,
BZ_STREAM_END, or BZ_OK. However, in attempting to write bindings, I get
BZ_SEQUENCE_ERROR as a return value!

In fact, looking at the source code, (line 818 of bzlib.c), it returns
BZ_SEQUENCE_ERROR.

Cheers,
Vanessa McHale



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: Infelicity in manual bundled with bzip2 1.0.9

[Mark Wielaard]

[-- Attachment #1: Type: text/plain, Size: 490 bytes --]

Hi Vanessa,

On Sat, Jan 18, 2020 at 02:35:15PM -0600, Vanessa McHale wrote:
> According to the PDF manual (page 17), BZ2_bzDecompress can return one
> of BZ_PARAM_ERROR, BZ_DATA_ERROR, BZ_DATA_ERROR_MAGIC, BZ_MEM_ERROR,
> BZ_STREAM_END, or BZ_OK. However, in attempting to write bindings, I get
> BZ_SEQUENCE_ERROR as a return value!
> 
> In fact, looking at the source code, (line 818 of bzlib.c), it returns
> BZ_SEQUENCE_ERROR.

You are right. I fixed it as attached.

Thanks,

Mark




[-- Attachment #2: 0001-manual.xml-Add-BZ_SEQUENCE_ERROR-to-return-values-of.patch --]
[-- Type: text/x-diff, Size: 863 bytes --]

From 4022613462968382ad707a67d2a1c4daf99a6cec Mon Sep 17 00:00:00 2001
From: Mark Wielaard <mark@klomp.org>
Date: Sun, 17 May 2020 15:43:45 +0200
Subject: [PATCH] manual.xml: Add BZ_SEQUENCE_ERROR to return values of
 BZ2_bzDecompress

BZ_SEQUENCE_ERROR can be returned if BZ2_bzDecompress is called after
an earlier call already returned BZ_STREAM_END.

Reported-by: Vanessa McHale <vamchale@gmail.com>
---
 manual.xml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/manual.xml b/manual.xml
index 7c9e4ec..ba0480e 100644
--- a/manual.xml
+++ b/manual.xml
@@ -1583,6 +1583,8 @@ BZ_MEM_ERROR
 BZ_STREAM_END
   if the logical end of the data stream was detected and all
   output in has been consumed, eg s-->avail_out > 0
+BZ_SEQUENCE_ERROR
+  if called after an earlier call already returned BZ_STREAM_END
 BZ_OK
   otherwise
 </programlisting>
-- 
2.20.1