Adding upstream version 0.3.upstream/0.3

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 47 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1b26b05
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+Description
+
+Xlunzip is a test tool for the lzip decompression code of my lzip patch
+for linux. Xlunzip is similar to lunzip, but it uses the lzip_decompress
+linux module as a backend. Xlunzip tests the module for stream,
+buffer-to-buffer and mixed decompression modes, including in-place
+decompression (using the same buffer for input and output). You can use
+xlunzip to verify that the module produces correct results when
+decompressing single member files, multimember files, or the
+concatenation of two or more compressed files. Xlunzip can be used with
+unzcrash to test the robustness of the module to the decompression of
+corrupted data.
+
+Note that the in-place decompression of concatenated files can't be
+guaranteed to work because an arbitrarily low compression ratio of the
+last part of the data can be achieved by appending enough empty
+compressed members to a file.
+
+The xlunzip tarball contains a copy of the lzip_decompress module and
+can be compiled and tested without downloading or applying the patch to
+the kernel.
+ 
+My lzip patch for linux can be found at
+http://download.savannah.gnu.org/releases/lzip/kernel/
+
+Lzip related components in the kernel
+=====================================
+
+The lzip_decompress module in lib/lzip.c provides a versatile lzip
+decompression function able to do buffer to buffer decompression or
+stream decompression with fill and flush callback functions. The usage
+of the function is documented in include/linux/lzip.h.
+
+For decompressing the kernel image, initramfs, and initrd, there is a
+wrapper function in lib/decompress_lunzip.c providing the same common
+interface as the other decompress_*.c files, which is defined in
+include/linux/decompress/generic.h.
+
+
+Copyright (C) 2016-2018 Antonio Diaz Diaz.
+
+This file is free documentation: you have unlimited permission to copy,
+distribute and modify it.
+
+The file Makefile.in is a data file used by configure to produce the
+Makefile. It has the same copyright owner and permissions that configure
+itself.