X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.rst;h=12bf92c5e5afdb8485ec75b2e9d4e428f50d6dbe;hb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;hp=31f4af9abafa6577afae01800e54fa5d48b283b7;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst
index 31f4af9a..12bf92c5 100644
--- a/docs/memcached_create.rst
+++ b/docs/memcached_create.rst
@@ -1,52 +1,37 @@
-.. highlight:: perl
+======================================
+Creating and destroying a memcached_st
+======================================
 
+.. index:: object: memcached_st
 
-****
-NAME
-****
-
-
-memcached_create, memcached_free, memcached_clone, memcached_servers_reset- Create a memcached_st structure
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
-
+--------
 
-
-.. code-block:: perl
-
-   #include <memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
  
-   void memcached_free (memcached_st *ptr);
+.. c:function:: void memcached_free (memcached_st *ptr);
  
-   memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
  
-   void memcached_servers_reset(memcached_st);
+.. c:function:: void memcached_servers_reset(memcached_st);
 
+Compile and link with -lmemcached
 
 
-***********
+-----------
 DESCRIPTION
-***********
-
+-----------
 
 memcached_create() is used to create a \ ``memcached_st``\  structure that will then
 be used by other libmemcached(3) functions to communicate with the server. You
 should either pass a statically declared \ ``memcached_st``\  to memcached_create() or
 a NULL. If a NULL passed in then a structure is allocated for you.
 
+Please note, when you write new application use memcached_create_with_options() over memcached_create().
+
 memcached_clone() is similar to memcached_create(3) but it copies the
 defaults and list of servers from the source \ ``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().
@@ -65,9 +50,9 @@ stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_create() returns a pointer to the memcached_st that was created
@@ -77,27 +62,18 @@ memcached_clone() returns a pointer to the memcached_st that was created
 (or initialized). On an allocation failure, it returns NULL.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
-******
-AUTHOR
-******
 
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_strerror(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`