summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2005-08-31 16:52:40 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2005-08-31 16:52:40 (GMT)
commit2330e9eed9e2661e5ebb8da732254b65ee3c024c (patch)
tree4c0385e8dc9d8374df6c0fae7504fa587889c2af
parent8230df399205458d4b44190c5df3787b823f375e (diff)
downloadcpython-2330e9eed9e2661e5ebb8da732254b65ee3c024c.zip
cpython-2330e9eed9e2661e5ebb8da732254b65ee3c024c.tar.gz
cpython-2330e9eed9e2661e5ebb8da732254b65ee3c024c.tar.bz2
From c.l.py comments: link to zlib manual, and disclaim completeness
-rw-r--r--Doc/lib/libzlib.tex11
1 files changed, 9 insertions, 2 deletions
diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex
index a387ee9..03e56f4 100644
--- a/Doc/lib/libzlib.tex
+++ b/Doc/lib/libzlib.tex
@@ -8,11 +8,16 @@
For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library.
-The zlib library has its own home page at \url{http://www.gzip.org/zlib/}.
+The zlib library has its own home page at \url{http://www.zlib.net}.
There are known incompatibilities between the Python module and
versions of the zlib library earlier than 1.1.3; 1.1.3 has a security
vulnerability, so we recommend using 1.1.4 or later.
+zlib's functions have many options and often need to be used in a
+particular order. This documentation doesn't attempt to cover all of
+the permutations; consult the zlib manual at
+\url{http://www.zlib.net/manual.html} for authoritative information.
+
The available exception and functions in this module are:
\begin{excdesc}{error}
@@ -171,5 +176,7 @@ action is to delete the object.
\begin{seealso}
\seemodule{gzip}{Reading and writing \program{gzip}-format files.}
- \seeurl{http://www.gzip.org/zlib/}{The zlib library home page.}
+ \seeurl{http://www.zlib.net}{The zlib library home page.}
+ \seeurl{http://www.zlib.net/manual.html}{The zlib manual explains
+ the semantics and usage of the library's many functions.}
\end{seealso}