* Add new docs/NEWS file, updated for 0.2 release.

 * Add warning to examples/core-browse-services.c, warning
   the onlooker that they are probably looking for
   client-browse-services.c

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

diff --git a/docs/NEWS b/docs/NEWS
new file mode 100644 (file)
index 0000000..051965a
--- /dev/null
+++ b/docs/NEWS
@@ -0,0 +1,51 @@
+$Id$
+
+Avahi 0.2, the 'Dzień Dobry' release
+====================================
+
+ * Unfortunately this release broke the API/ABI of libavahi-client
+   with the following function removals
+
+   Removal of these functions may affect users of the 0.1 API
+    - avahi_service_resolver_block()
+
+   The following functions were simply for debugging information
+   and their removal should not affect anyone
+    - avahi_entry_group_get_dbus_path()
+    - avahi_domain_browser_get_dbus_path()
+    - avahi_service_type_browser_get_dbus_path()
+    - avahi_service_browser_get_dbus_path()
+
+   Note that while the libavahi-client API changed slightly, the DBUS
+   API itself has only had additions and no existing definitions
+   have changed.
+ 
+ * avahi-daemon will now ignore local IP addresses with the "link" scope
+   unless it is the only IP address on the interface.
+ * avahi-daemon will no longer fail to start if D-BUS is not
+   available (if configured with enable-dbus=warn)
+ * Fixed a potential crasher when resolving things in libavahi-core.
+ * New example demonstrating integration into glib applications
+ * Addition new convenience AvahiStringList functions
+   avahi_string_list_find()
+   avahi_string_list_get_pair()
+   avahi_string_list_add_pair()
+   avahi_string_list_add_pair_arbitrary()
+ * Fixed a typo in avahi-glib.pc that stopped programs using
+   the GLIB api from compiling correctly
+ * A critical bug in the reflector was fixed where it may go into a
+   state of constantly flooding queries out to the network.
+ * Introduced new asynchronous resolver API
+ * libavahi-client gained an API for resolving HostNames and Addresses
+   in addition to the ServiceResolver provided in 0.1
+ * Added support for Arch and Gentoo linux distributions.
+ * Allowed configuration on non-supported distributions
+ * Fixed a critical bug where you cannot use more than one AvahiClient 
+   or use it in an application already using D-BUS
+ * Fixed assembly of empty string lists to RFC compliant TXT records
+ * Added a new service type description database with human
+   understandable descriptions of services and translations.
+ * Fixed various minor memory corruption bugs
+ * Fixed an issue where Avahi might think it encountered a conflict
+   if the process or machine has been suspended
+ * Fixed compilation and runtime issues on 64-bit distributions

diff --git a/docs/TODO b/docs/TODO
index 33b6f73be9f22d780fe94116a25a443fc2f6e193..02b189bf33cfa214b407a0cecac931dba93221a2 100644 (file)
--- a/docs/TODO
+++ b/docs/TODO
@@ -1,5 +1,5 @@
 todo:
-* release 0.2!
+* nothing
 
 later:
 * Add sensible record updateing API
@@ -58,3 +58,4 @@ done:
    * service resolving
    * examples
 * publish IP addresses with scope "link" only, unless ther are the only one the interface
+* release 0.2!

diff --git a/examples/core-browse-services.c b/examples/core-browse-services.c
index e72333992bc5dcaab5b7f71e760e321e5ac012a0..d91a67c54850d05a8fa897526611911689dd19c6 100644 (file)
--- a/examples/core-browse-services.c
+++ b/examples/core-browse-services.c
@@ -1,5 +1,16 @@
 /* $Id$ */
 
+/* PLEASE NOTE *
+ * This file demonstrates how to use Avahi's core API, this is
+ * the embeddable mDNS stack for embedded applications.
+ *
+ * End user applications should *not* use this API and should use
+ * the DBUS or C APIs, please see
+ * client-browse-services.c and glib-integration.c
+ * 
+ * I repeat, you probably do *not* want to use this example.
+ */
+
 /***
   This file is part of avahi.