Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / memcached_create.rst

diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst
index 1beff43c507d6274d4a6c919d1dc98643c484a1c..ae851ba99ceebf9d4e269f57a7e8159d5bae2e8d 100644 (file)
--- a/docs/memcached_create.rst
+++ b/docs/memcached_create.rst
@@ -1,102 +1,83 @@
-.. highlight:: perl
+======================================
+Creating and destroying a memcached_st
+======================================
 
-
-memcached_create, memcached_free, memcached_clone, memcached_servers_reset
-**************************************************************************
-
-
-Create a memcached_st structure
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
+--------
 
+#include <libmemcached/memcached.h>
 
+.. c:type:: memcached_st
 
-.. code-block:: perl
-
-   #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
+:c:func:`memcached_create` is used to create a :c:type:`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 
+:c:type:`memcached_st` to :c:func:`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 \ ``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 destination argument is NULL a \ ``memcached_st``\  will be allocated for you.
+Please note, when you write new application use 
+:c:func:`memcached` over :c:func:`memcached_create`.
 
-memcached_servers_reset() allows you to zero out the list of servers that
-the memcached_st has.
+:c:func:`memcached_clone` is similar to :c:func:`memcached_create` but 
+it copies the defaults and list of servers from the source 
+:c:type:`memcached_st`. If you pass a null as the argument for the source 
+to clone, it is the same as a call to :c:func:`memcached_create`.
+If the destination argument is NULL a :c:type:`memcached_st` will be allocated 
+for you.
 
-To clean up memory associated with a \ ``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.
+:c:func:`memcached_servers_reset` allows you to zero out the list of 
+servers that the :c:type:`memcached_st` has.
+
+To clean up memory associated with a :c:type:`memcached_st` structure you 
+should pass it to :c:func:`memcached_free` when you are finished using it. 
+:c:func:`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.
 
 
-******
+------
 RETURN
-******
+------
 
 
-memcached_create() returns a pointer to the memcached_st that was created
-(or initialized). On an allocation failure, it returns NULL.
+:c:func:`memcached_create` returns a pointer to the :c:type:`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.
+:c:func:`memcached_clone` returns a pointer to the :c:type:`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)`