priv: correctly handle lldpcli exit

[thirdparty/lldpd.git] / README.md

diff --git a/README.md b/README.md
index 81ce7c630caf191991b9c914aacad19b82d99e21..909f5659cde98b8a92572712f49cc0311358ff4e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,6 +31,10 @@ The following OS are supported:
  * OpenBSD
  * Solaris
 
+Windows is not supported but you can use
+[WinLLDPService](https://github.com/raspi/WinLLDPService/) as a
+transmit-only agent.
+
 Installation
 ------------
 
@@ -62,7 +66,7 @@ Installation (OS X)
 The same procedure as above applies for OS X. However, there are
 simpler alternatives:
 
- 1. Use [Homebrew](http://mxcl.github.io/homebrew/):
+ 1. Use [Homebrew](https://brew.sh):
 
         brew install lldpd
         # Or, for the latest version:
@@ -73,7 +77,7 @@ simpler alternatives:
  
         mkdir build && cd build
         ../configure --prefix=/usr/local --localstatedir=/var --sysconfdir=/private/etc --with-embedded-libevent \
-            --without-json --without-snmp
+            --without-snmp
         make -C osx pkg
 
     If you want to compile for an older version of OS X, you need
@@ -82,7 +86,7 @@ simpler alternatives:
         SDK=/Developer/SDKs/MacOSX10.6.sdk
         mkdir build && cd build
         ../configure --prefix=/usr/local --localstatedir=/var --sysconfdir=/private/etc --with-embedded-libevent \
-           --without-json --without-snmp \
+           --without-snmp \
            CFLAGS="-mmacosx-version-min=10.6 -isysroot $SDK" \
            LDFLAGS="-mmacosx-version-min=10.6 -isysroot $SDK"
         make -C osx pkg
@@ -93,7 +97,7 @@ simpler alternatives:
 
         mkdir build && cd build
         ../configure --prefix=/usr/local --localstatedir=/var --sysconfdir=/private/etc --with-embedded-libevent \
-           --without-json --without-snmp \
+           --without-snmp \
            CFLAGS="-mmacosx-version-min=10.9" \
            LDFLAGS="-mmacosx-version-min=10.9"
         make -C osx pkg
@@ -163,7 +167,7 @@ interfaces of the bond. In this case, lldpd will affect a received
 randomly to one of the interface (so a neighbor may be affected to the
 wrong interface).
 
-On 2.6.27, we are able to receive packets on real interface for bonded
+On 2.6.27, we are able to receive packets on real interface for enslaved
 devices. This allows one to get neighbor information on active/backup
 bonds. Without the 2.6.27, lldpd won't receive any information on
 inactive slaves. Here are the patchs (thanks to Joe Eykholt):
@@ -249,11 +253,20 @@ that:
     afl-fuzz -i inputs -o outputs ./decode @@
 
 There is a general test suite with `make check`. It's also possible to
-run integration tests with `make integration-tests && sh
-./integration-tests`. Those are not very flexible and may or may not
-work depending on your platform. Also check the content of
-`tests/lldpcli.conf`. It's a configuration file that should cover all
-commands present in lldpcli.
+run integration tests. They need [py.test](http://pytest.org/latest/)
+and rely on Linux containers to be executed.
+
+To enable code coverage, use:
+
+    ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var \
+                 --enable-sanitizers --enable-gcov --with-snmp \
+                 CFLAGS="-O0 -g"
+    make
+    make check
+    # maybe, run integration tests
+    lcov --base-directory $PWD/src/lib \
+         --directory src --capture --output-file gcov.info
+    genhtml gcov.info --output-directory coverage
 
 Embedding
 ---------