X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fmemcached_create.rst;h=782b1a06b9682d5606d2c5d3250f959905cf8127;hb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;hp=228dd570f3d10cb92760ccf221ebf745c53759b2;hpb=1a237369acc2140ec76f46202dfde37047ef140d;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst
index 228dd570..782b1a06 100644
--- a/docs/memcached_create.rst
+++ b/docs/memcached_create.rst
@@ -2,9 +2,7 @@
 Creating and destroying a memcached_st
 ======================================
 
-
-Create a memcached_st structure
-
+.. index:: object: memcached_st
 
 --------
 SYNOPSIS
@@ -22,28 +20,35 @@ SYNOPSIS
 
 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_create_with_options()` over 
+:c:func:`memcached_create()`.
+
+: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.
 
-memcached_servers_reset() allows you to zero out the list of servers that
-the memcached_st has.
+: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 \ ``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.
+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
@@ -55,11 +60,11 @@ 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.
 
 
 ----
@@ -68,15 +73,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-------
-AUTHOR
-------
-
-
-Brian Aker, <brian@tangent.org>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------