X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.pod;h=8c6a1a2233cc526948531a1c4789d7cf3b253ab8;hb=ff2f828a531d23ee087940fed20e8798fdf2c204;hp=f76e9c7ef83c0be6d54275f923f307853b7313be;hpb=77d70ea2571e43495bb66efb9072f6a8b5009b64;p=m6w6%2Flibmemcached diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod old mode 100755 new mode 100644 index f76e9c7e..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,13 +26,17 @@ 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. 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 will be allocated for you. +If the destination argument is NULL a C will be allocated for you. To clean up memory associated with a C 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