Minor fixes to documentation.
Fri Sep 5 19:28:23 PDT 2008 mail@chaitanyagupta.com
* Minor fixes to documentation.
diff -rN -u old-cl-bzip2/doc/index.html new-cl-bzip2/doc/index.html
--- old-cl-bzip2/doc/index.html 2014-07-29 22:05:23.000000000 -0700
+++ new-cl-bzip2/doc/index.html 2014-07-29 22:05:23.000000000 -0700
@@ -127,7 +127,7 @@
<b>compress</b> <i>in out <tt>&amp;key</tt> block-size-100k verbosity work-factor</i></p>
<blockquote>
- <p>Compresses data from IN to <span class="caps">OUT</span>. IN or <span class="caps">OUT</span> can either be a binary stream or a pathname.</p>
+ <p>Compresses data from <i><code>IN</code></i> to <i><code>OUT</code></i>. <i><code>IN</code></i> or <i><code>OUT</code></i> can either be a binary stream or a pathname.</p>
<p><i><code>BLOCK-SIZE-100K</code></i> (default 9), <i><code>VERBOSITY</code></i> (default 0) and <i><code>WORK-FACTOR</code></i> (default 30) correspond to the parameters <i><code>blockSize100k</code></i>, <i><code>verbosity</code></i> and <i><code>workFactor</code></i>, respectively, for the libbzip2 function <i><code>BZ2_bzCompressInit</code></i>.</p>
<p>From the bzip2 manual:</p>
<p>Parameter <i><code>blockSize100k</code></i> 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.</p>
@@ -139,7 +139,7 @@
<b>decompress</b> <i>in out <tt>&amp;key</tt> verbosity smallp</i></p>
<blockquote>
- <p>Decompresses data from IN to <span class="caps">OUT</span>. IN or <span class="caps">OUT</span> can either be a binary stream or a pathname.</p>
+ <p>Decompresses data from <i><code>IN</code></i> to <i><code>OUT</code></i>. <i><code>IN</code></i> or <i><code>OUT</code></i> can either be a binary stream or a pathname.</p>
<p><i><code>VERBOSITY</code></i> and <i><code>SMALLP</code></i> (default <span class="caps">NIL</span>) correspond to the parameters <i><code>verbosity</code></i> and <i><code>small</code></i>, respectively, for the libbzip2 function <i><code>BZ2_bzDecompressInit</code></i>.</p>
<p>For the meaning of <i><code>VERBOSITY</code></i>, see the documentation for <span class="caps">COMPRESS</span>. A non-<span class="caps">NIL</span> value for <i><code>SMALLP</code></i> corresponds to a non-zero value for the parameter <i><code>small</code></i>. Here&#8217;s what the bzip2 manual says about <i><code>small</code></i>:</p>
<p>If <i><code>small</code></i> 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).</p>
diff -rN -u old-cl-bzip2/doc/index.textile new-cl-bzip2/doc/index.textile
--- old-cl-bzip2/doc/index.textile 2014-07-29 22:05:23.000000000 -0700
+++ new-cl-bzip2/doc/index.textile 2014-07-29 22:05:23.000000000 -0700
@@ -105,7 +105,7 @@
p(symbol). [Function]
<b>compress</b> <i>in out <tt>&amp;key</tt> block-size-100k verbosity work-factor</i>
-bq.. Compresses data from IN to OUT. IN or OUT can either be a binary stream or a pathname.
+bq.. Compresses data from <i>@IN@</i> to <i>@OUT@</i>. <i>@IN@</i> or <i>@OUT@</i> can either be a binary stream or a pathname.
<i>@BLOCK-SIZE-100K@</i> (default 9), <i>@VERBOSITY@</i> (default 0) and <i>@WORK-FACTOR@</i> (default 30) correspond to the parameters <i>@blockSize100k@</i>, <i>@verbosity@</i> and <i>@workFactor@</i>, respectively, for the libbzip2 function <i>@BZ2_bzCompressInit@</i>.
@@ -120,7 +120,7 @@
p(symbol). [Function]
<b>decompress</b> <i>in out <tt>&amp;key</tt> verbosity smallp</i>
-bq.. Decompresses data from IN to OUT. IN or OUT can either be a binary stream or a pathname.
+bq.. Decompresses data from <i>@IN@</i> to <i>@OUT@</i>. <i>@IN@</i> or <i>@OUT@</i> can either be a binary stream or a pathname.
<i>@VERBOSITY@</i> and <i>@SMALLP@</i> (default NIL) correspond to the parameters <i>@verbosity@</i> and <i>@small@</i>, respectively, for the libbzip2 function <i>@BZ2_bzDecompressInit@</i>.