soylent r278 - in trunk: . docs/reference/libsoylent libsoylent

[svenp svn gnome org]

Author: svenp
Date: Tue Aug 12 12:10:45 2008
New Revision: 278
URL: http://svn.gnome.org/viewvc/soylent?rev=278&view=rev

Log:
prepared libsoylent release (NEWS, README, version-numbers)

Modified:
   trunk/configure.ac
   trunk/docs/reference/libsoylent/libsoylent-docs.sgml
   trunk/libsoylent/NEWS
   trunk/libsoylent/README

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Tue Aug 12 12:10:45 2008
@@ -7,8 +7,8 @@
 m4_define(soylent_major_minor, soylent_major_version.soylent_minor_version)
 
 m4_define(libsoylent_major_version, 0)
-m4_define(libsoylent_minor_version, 2)
-m4_define(libsoylent_micro_version, 1)
+m4_define(libsoylent_minor_version, 4)
+m4_define(libsoylent_micro_version, 0)
 m4_define(libsoylent_version, libsoylent_major_version.libsoylent_minor_version.libsoylent_micro_version)
 
 AC_INIT(soylent, soylent_version)

Modified: trunk/docs/reference/libsoylent/libsoylent-docs.sgml
==============================================================================
--- trunk/docs/reference/libsoylent/libsoylent-docs.sgml	(original)
+++ trunk/docs/reference/libsoylent/libsoylent-docs.sgml	Tue Aug 12 12:10:45 2008
@@ -5,7 +5,7 @@
   <bookinfo>
     <title>libsoylent Reference Manual</title>
     <releaseinfo>
-      for libsoylent v0.2.0; the latest version of this documentation can be found on-line at
+      for libsoylent v0.4.0; the latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://kalterregen.de/libsoylent/index.html";>http://kalterregen.de/libsoylent</ulink>.
     </releaseinfo>
   </bookinfo>

Modified: trunk/libsoylent/NEWS
==============================================================================
--- trunk/libsoylent/NEWS	(original)
+++ trunk/libsoylent/NEWS	Tue Aug 12 12:10:45 2008
@@ -1,3 +1,57 @@
+=== 2008.08.12: libsoylent v0.4.0 "small step, giant leap" ===
+
+Let me present you the newest version of libsoylent: 0.4.0. Three weeks of hard
+work went into this release, and in fact so much was added and changed that we
+decided to skip a version-number. Sorry 0.3.0.
+
+So, what's in it? More or less a complete people-management-library. Our goal
+was to create a simple-yet-powerful API that "just works". Hopefully we managed
+that. If you have no clear picture of what libsoylent is or just want to know
+more about it, look at the examples we've put up on the libsoylent-page [1].
+
+What comes next? Because the library is that new and fresh, much testing will
+be needed. If you want to help, just play around with libsoylent and report
+bugs that you may encounter to our mailinglist. Thanks! Besides, next to the
+need of more documentation and polishing, here is a list of features that will
+follow in the next releases:
+ * live-attributes (e.g. online-status)
+ * communication (launch applications for chat / mail etc.)
+ * address-book searching (atm you can only get all people)
+ * people association / merging
+
+Please leave a comment on my blog [2] if you have thoughts, ideas, criticism,
+feature-requests or suggestions for changing something. Just let us hear your
+opinion.
+
+Anyway, if you're working on something that needs people-functionality, why not
+give libsoylent a try?
+
+[1] http://live.gnome.org/Soylent/libsoylent#head-350076c20ead379a4d797b273ff4db09e67c22ab
+[2] http://www.kalterregen.de/blog/
+
+--- Changes ---
+
+ * creating and modifying attributes works
+ * adding / removing attributes to / from people works
+ * attribute-mapping (for C runtime-types) implemented
+ * attribute-system (definition, cleanup and to-string functionality)
+   implemented
+ * changes to people can be commited
+ * loading people from the addressbook implemented
+ * signals for SlBook, SlPerson and SlAttribute implemented
+ * integrated gtk-doc
+ * added a bunch of documentation
+ * added more tests
+ * added example-code (three examples)
+ * revised architecture
+ * a lot of internal-code improvements
+ * fixed a bunch of bugs
+ * added debugging functions
+ * a lot of polishing was done (code-cleanup, convinience functions and macros
+   etc.)
+
+--------------------------------------------------------------------------------
+
 === 2008.07.23: libsoylent v0.2.0 "management qualities" ===
 
 The second release features the basic functionality one would expect from a

Modified: trunk/libsoylent/README
==============================================================================
--- trunk/libsoylent/README	(original)
+++ trunk/libsoylent/README	Tue Aug 12 12:10:45 2008
@@ -1,9 +1,9 @@
 === libsoylent ===
 
 libsoylent provides a convinient way to manage people and information associated
-with them. Features are a system-wide addressbook, arbitrary people and group
-attributes, static (e.g. name) and dynamic (e.g. online-status) information,
-etc. This comes in the form of a clean object-orientated API.
+with them. Features are a system-wide addressbook, arbitrary people attributes,
+static (e.g. name) and dynamic (e.g. online-status) information, etc. This comes
+in the form of a clean object-orientated API.
 
 More information is available at:
 
@@ -11,8 +11,8 @@
 
 --- State ---
 
-v0.2.*: libsoylent is work-in-progress. Addressbook and people management work
-at a very basic level. Modifying attributes of people is not implemented yet.
+v0.4.*: libsoylent is work-in-progress. Some minor features are missing, but
+the core-functionality is implemented. The library still needs some testing.
 Even if it's unlikely that libsoylent will cause any damage you are encouraged
 (as with any work-in-progress software) to backup your system (or at least
 your ~/.evolution directory) before using libsoylent.
@@ -34,6 +34,11 @@
 It is also located in the source under the docs/references/libsoylent/html
 directory.
 
+--- Examples ---
+
+The examples in the libsoylent/example directory will give a good introduction
+to libsoylent.
+
 --- Building libsoylent ---
 
 libsoylent uses autotools for building. To build libsoylent (and Soylent)
@@ -51,6 +56,20 @@
 
 That's it!
 
+--- Debugging ---
+
+If you want to have detailed information about what's going on in libsoylent,
+define one or more of the following macros in `sl-priv-util.h`, depending on
+what you want to debug. Then rebuild libsoylent.
+
+Note that this may produce a lot of output.
+
+SL_ENABLE_DEBUG_ALL
+SL_ENABLE_DEBUG_BOOK
+SL_ENABLE_DEBUG_ENTITY
+SL_ENABLE_DEBUG_ATTRIBUTE
+SL_ENABLE_DEBUG_UTIL
+
 --- Contact ---
 
 Bugs, feature requests, questions and related discussion go to the Soylent
@@ -60,6 +79,9 @@
 
 --- Known Bugs ---
 
+Note: because of bug 1 to 3, addressbook functionality has been disabled in
+v0.4.0, i.e. you can only use the default addressbook.
+
  * [1] if you have never started Evolution before there will be no system-
    addressbook, so all addressbook-functions will fail [TODO; workaround:
    start Evolution once]
@@ -68,3 +90,5 @@
    to delete the addressbook again]
  * [3] adding people to any addressbook but the default addressbook kills E-D-S
    [TODO; no workaround atm]
+ * [4] addresses stored via libsoylent are not displayed in Evolution [TODO;
+   workaround: use Evolution to store addresses]