X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.pod;h=8c6a1a2233cc526948531a1c4789d7cf3b253ab8;hb=0d39f7b5b66c33ea5eaa88bb469d0ce382bb24eb;hp=8d1a76b47be3df68cbb00429bb039c0bdbe825a5;hpb=8a5081c5ed9c33b1d6d5f070ba97b2b21b7a0da8;p=awesomized%2Flibmemcached

diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod
old mode 100755
new mode 100644
index 8d1a76b4..8c6a1a22
--- 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,7 +14,7 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   void memcached_free (memcached_st *ptr);
 
-  memcached_st *memcached_clone(memcached_st *clone, memcached_st *source);
+  memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
 
 =head1 DESCRIPTION
 
@@ -26,21 +26,24 @@ 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 the destination argument is NULL a C<memcached_st> will be allocated for you.
 
 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
 the structure.
 
+You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
+
 =head1 RETURN
 
 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()).
+(or initialized). On an allocation failure, it returns NULL.
 
 =head1 HOME