Updated docstrings.
Thu Sep 4 12:02:04 PDT 2008 mail@chaitanyagupta.com
* Updated docstrings.
diff -rN -u old-cl-bzip2/bzip2.lisp new-cl-bzip2/bzip2.lisp
--- old-cl-bzip2/bzip2.lisp 2014-07-27 23:16:03.000000000 -0700
+++ new-cl-bzip2/bzip2.lisp 2014-07-27 23:16:03.000000000 -0700
@@ -343,7 +343,26 @@
BLOCK-SIZE-100K, VERBOSITY and WORK-FACTOR correspond to the
parameters `blockSize100k', `verbosity' and `workFactor',
- respectively, for the libbzip2 function `BZ2_bzCompressInit'."
+ respectively, for the libbzip2 function `BZ2_bzCompressInit'.
+
+From the bzip2 manual:
+
+Parameter `blockSize100k' specifies the block size to be used for
+compression. It should be a value between 1 and 9 inclusive, and
+the actual block size used is 100000 x this figure. 9 gives the
+best compression but takes most memory.
+
+Parameter `verbosity' should be set to a number between 0 and 4
+inclusive. 0 is silent, and greater numbers give increasingly
+verbose monitoring/debugging output.
+
+Parameter `workFactor' controls how the compression phase behaves
+when presented with worst case, highly repetitive, input data. If
+compression runs into difficulties caused by repetitive data, the
+library switches from the standard sorting algorithm to a
+fallback algorithm. The fallback is slower than the standard
+algorithm by perhaps a factor of three, but always behaves
+reasonably, no matter how bad the input."
(let ((*block-size-100k* block-size-100k)
(*verbosity* verbosity)
(*work-factor* work-factor))
@@ -413,7 +432,17 @@
VERBOSITY and SMALLP correspond to the parameters `verbosity' and
`workFactor', respectively, for the libbzip2 function
- `BZ2_bzDecompressInit'."
+ `BZ2_bzDecompressInit'.
+
+For the meaning of VERBOSITY, see the documentation for
+COMPRESS. For SMALLP, here's the corresponding entry from
+the bzip2 manual:
+
+If `small' is nonzero, the library will use an alternative
+decompression algorithm which uses less memory but at the cost of
+decompressing more slowly (roughly speaking, half the speed, but
+the maximum memory requirement drops to around 2300k). See How to
+use bzip2 for more information on memory management."
(let ((*verbosity* verbosity)
(*smallp* smallp))
(decompress-aux in out)))