A number of fixes/etc.

[m6w6/libmemcached] / docs / memcached_server_st.pod

diff --git a/docs/memcached_server_st.pod b/docs/memcached_server_st.pod
index 32d4e1e98344b014e88fae9564707b3f9dfd9c69..d50334ae26eb2103e80df6180ad8884fc277e245 100644 (file)
--- a/docs/memcached_server_st.pod
+++ b/docs/memcached_server_st.pod
@@ -11,21 +11,25 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
-  void memcached_server_list_free (memcached_server_st *ptr);
+  const memcached_server_instance_st
+    memcached_server_list (memcached_st *ptr);
 
-  memcached_server_st *
-    memcached_server_list_append (memcached_server_st *ptr, 
+  void memcached_server_list_free (memcached_server_list_st list);
+
+  memcached_server_list_st
+    memcached_server_list_append (memcached_server_list_st list, 
                                   const char *hostname,
                                   unsigned int port, 
                                   memcached_return_t *error);
 
-  unsigned int memcached_server_list_count (memcached_server_st *ptr);
+  uint32_t memcached_server_list_count (memcached_server_list_st list);
 
-  memcached_server_st *memcached_servers_parse (const char *server_strings);
+  memcached_server_list_st memcached_servers_parse (const char *server_strings);
 
-  const char *memcached_server_error (memcached_server_st *ptr);
+  const char *memcached_server_error (memcached_server_instance_st instance);
 
-  void memcached_server_error_reset (memcached_server_st *ptr);
+  DEPRECATED
+  void memcached_server_error_reset (memcached_server_instance_st list);
 
 =head1 DESCRIPTION
 
@@ -34,6 +38,9 @@ memcached_server_st structures. You should not modify these structures
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 
+memcached_server_list() is used to provide an array of all defined hosts.
+This was incorrectly documented as "requiring free()" up till version 0.39.
+
 memcached_server_list_free() deallocates all memory associated with the array
 of memcached_server_st that you passed to it. 
 
@@ -49,9 +56,11 @@ The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
 be set to the default port, while that host will have a port of 555.
 
 memcached_server_error() can be used to look at the text of the last error 
-message sent by the server to to the client. Use memcached_server_error_reset() 
-to reset the message (this does not currently free up the memory associated
-with the message).
+message sent by the server to to the client.
+
+Before version 0.39 theses functions used a memcache_server_st *. In 0.39
+memcached_server_st * was aliased to memcached_server_list_st. This was
+done for a style reason/to help clean up some concepts in the code. 
 
 
 =head1 RETURN