Add memcached_[gs]et_memory_allocators to the main libmemcached man page

[awesomized/libmemcached] / docs / memcached_create.pod

diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod
old mode 100755 (executable)
new mode 100644 (file)
index cbe6fc1..6150f00
--- a/docs/memcached_create.pod
+++ b/docs/memcached_create.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_create, memcached_free
+memcached_create, memcached_free - Create a memcached_st structure
 
 =head1 LIBRARY
 
@@ -14,6 +14,8 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   void memcached_free (memcached_st *ptr);
 
+  memcached_st *memcached_clone(memcached_st *clone, memcached_st *source);
+
 =head1 DESCRIPTION
 
 memcached_create() is used to create a C<memcached_st> structure that will then
@@ -21,6 +23,13 @@ be used by other libmemcached(3) functions to communicate with the server. You
 should either pass a statically declared C<memcached_st> to memcached_create() or
 a NULL. If a NULL passed in then a structure is allocated for you.
 
+memcached_clone() is similar to memcached_create(3) but it copies the
+defaults and list of servers from the source C<memcached_st>. If you pass a null as
+the argument for the source to clone, it is the same as a call to memcached_create().
+If the clone argument is NULL a C<memcached_st> will be allocated for you.
+If you pass a pointer to a memory area for the clone pointer, make sure you 
+memset it to 0 (unless you got the clone from a factory method in libmemcached).
+
 To clean up memory associated with a C<memcached_st> structure you should pass
 it to memcached_free() when you are finished using it. memcached_free() is
 the only way to make sure all memory is deallocated when you finish using
@@ -31,6 +40,10 @@ the structure.
 memcached_create() returns a pointer to the memcached_st that was created
 (or initialized). On an allocation failure, it returns NULL.
 
+memcached_clone() returns a pointer to the memcached_st that was created
+(or initialized). On an allocation failure, it returns NULL. If you pass in 
+a preallocated structure it must be cleared first (aka memset()).
+
 =head1 HOME
 
 To find out more information please check: