Add a new documentation file telling distributors how to get full build system

compatibility with HOWL/Bonjour in addition to ABI/API compatibility.


git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1019 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe

2 files changed, 18 insertions, 3 deletions

diff --git a/docs/COMPAT-LAYERS b/docs/COMPAT-LAYERS
new file mode 100644
index 0000000..050c988
--- /dev/null
+++ b/docs/COMPAT-LAYERS
@@ -0,0 +1,18 @@
+Avahi 0.6.1 and above offer full API and ABI compatibility with HOWL
+and Bonjour out-of-the-box. To enable this you pass
+--enable-compat-libdns_sd and/or --enable-compat-howl to the configure
+script. The build system installs both a shared library libdns_sd.so
+and one named libhowl.so. These files might overwrite the original
+implementations, so take care!
+
+Distributors that want full build system compatibility in addition to
+ABI/API compatibility should:
+
+        1) Symlink the pkg-config file avahi-compat-howl.pc to howl.pc
+ 
+        2) Symlink $(includedir)/avahi-compat-libdns_sd/dns_sd.h to 
+           $(includedir)/dns_sd.h
+
+-- Lennart
+
+$Id$
diff --git a/docs/TODO b/docs/TODO
index 70db9b3..55f1aad 100644
--- a/docs/TODO
+++ b/docs/TODO
@@ -1,6 +1,3 @@
-for 0.6:
-* RELEASE!
-
 later:
 * add simplification routine for adding services 
 * support for special domain PTR records based on local IP subnet address