Wiretap isn't meant to be a packet-capture library [any more].
authorJeff Morriss <jeff.morriss.ws@gmail.com>
Fri, 21 Sep 2018 19:12:51 +0000 (15:12 -0400)
committerAnders Broman <a.broman58@gmail.com>
Mon, 24 Sep 2018 04:08:40 +0000 (04:08 +0000)
Wiretap was originally being writen to be a packet-capture library which
might eventually replace libpcap but that's no longer the case: it's now
meant to be a library for accessing multiple types of files.

As such, don't describe it in the README as a packet-capture-library-to-be;
in fact since it's really internal to Wireshark don't mention it at all.

Don't discuss the fact that ancient (pre-2003) versions of zlib don't work
for Wireshark's purposes.

Change-Id: I2387d0ecc65a66c21dd7db3a38b8fee7d32add7f
Reviewed-on: https://code.wireshark.org/review/29786
Reviewed-by: Anders Broman <a.broman58@gmail.com>
README.md

index 67e554a..a1d5305 100644 (file)
--- a/README.md
+++ b/README.md
@@ -84,20 +84,14 @@ option and interface feature.
 Multiple File Types
 -------------------
 
-The wiretap library is a packet-capture library currently under
-development parallel to Wireshark.  In the future it is hoped that
-wiretap will have more features than libpcap, but wiretap is still in
-its infancy. However, wiretap is used in wireshark for its ability
-to read multiple file types.  See the Wireshark man page or the
-Wireshark User's Guide for a list of supported file formats.
-
-In addition, it can read gzipped versions of any of those files
-automatically if you have the zlib library available when compiling
-Wireshark. Wireshark needs a modern version of zlib to be able to use
-zlib to read gzipped files; version 1.1.3 is known to work.  Versions
-prior to 1.0.9 are missing some functions that Wireshark needs and won't
-work.  CMake will automatically use zlib if it is found on your system.
-You can disable zlib support by running `cmake -DENABLE_ZLIB=OFF`.
+Wireshark can read packets from a number of different file types.  See
+the Wireshark man page or the Wireshark User's Guide for a list of
+supported file formats.
+
+Wireshark can transparently read gzipped versions of any of those files if
+zlib was available when Wireshark was compiled.  CMake will automatically
+use zlib if it is found on your system.  You can disable zlib support by
+running `cmake -DENABLE_ZLIB=OFF`.
 
 Although Wireshark can read AIX iptrace files, the documentation on
 AIX's iptrace packet-trace command is sparse.  The `iptrace` command