Merge in lp:504915

diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst
index 77eb9137319e54545fa1cb2047e7e44c991e63c6..e7ec65c97ac938d225080299f79dbdd5046e4750 100644 (file)
--- a/docs/memcached_server_st.rst
+++ b/docs/memcached_server_st.rst
@@ -3,8 +3,6 @@ Managing lists of servers
 =========================
 
 
 =========================
 
 

-.. index:: object: memcached_server_instance_st
-

 --------
 SYNOPSIS
 --------
 --------
 SYNOPSIS
 --------


@@ -12,18 +10,21 @@ SYNOPSIS
 
 
 #include <libmemcached/memcached.h>
 
 
 #include <libmemcached/memcached.h>

- 
-.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr);

 
 

-.. c:function:: void memcached_server_list_free (memcached_server_list_st list);
+.. c:type:: memcached_server_instance_st
+
+.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr)
+
+.. c:function:: void memcached_server_list_free (memcached_server_list_st list)

  
  

-.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error);
+.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error)

  
  

-.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list);
+.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)

  
  

-.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance);
+.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance)

  
  

-.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED 
+.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list)
+.. deprecated:: 0.39

    
 
 Compile and link with -lmemcached
    
 
 Compile and link with -lmemcached


@@ -39,25 +40,25 @@ memcached_server_st structures. You should not modify these structures
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 

-memcached_server_list() is used to provide an array of all defined hosts.
+:c:func:`memcached_server_list()` is used to provide an array of all defined hosts.

 This was incorrectly documented as "requiring free()" up till version 0.39.
 
 This was incorrectly documented as "requiring free()" up till version 0.39.
 

-memcached_server_list_free() deallocates all memory associated with the array
+:c:func:`memcached_server_list_free()` deallocates all memory associated with the array

 of memcached_server_st that you passed to it.
 
 of memcached_server_st that you passed to it.
 

-memcached_server_list_append() adds a server to the end of a
+:c:func:`memcached_server_list_append()` adds a server to the end of a

 memcached_server_st array. On error null will be returned and the
 memcached_return_t pointer you passed into the function will be set with the
 appropriate error. If the value of port is zero, it is set to the default
 port of a memcached server.
 
 memcached_server_st array. On error null will be returned and the
 memcached_return_t pointer you passed into the function will be set with the
 appropriate error. If the value of port is zero, it is set to the default
 port of a memcached server.
 

-DEPRECATED memcached_servers_parse(), please see :manpage:`memcached(3)`
+DEPRECATED :c:func:`memcached_servers_parse()`, please see :c:func:`memcached()`

 
 

-memcached_server_error() can be used to look at the text of the last error 
+:c:func:`memcached_server_error()` can be used to look at the text of the last error 

 message sent by the server to to the client.
 
 message sent by the server to to the client.
 

-Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
-memcached_server_st \* was aliased to memcached_server_list_st. This was
+Before version 0.39 these functions used a memcache_server_st \*. In 0.39
+memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was

 done for a style reason/to help clean up some concepts in the code.
 
 
 done for a style reason/to help clean up some concepts in the code.
 
 

diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst
index 5156b2a2c69e7c83e02b0f67a57c3f06045db21d..e280071d56467e0e93775e16beb4db16e19481dc 100644 (file)
--- a/docs/memcached_servers.rst
+++ b/docs/memcached_servers.rst
@@ -2,29 +2,29 @@
 Manipulate the server information stored in memcached_st
 ========================================================
 
 Manipulate the server information stored in memcached_st
 ========================================================
 

-.. index:: object: memcached_st
-
---------
-SYNOPSIS
+-------- 
+SYNOPSIS 

 --------
 
 #include <libmemcached/memcached.h>
  
 --------
 
 #include <libmemcached/memcached.h>
  

-.. c:function:: uint32_t memcached_server_count (memcached_st *ptr);
+.. c:type:: memcached_server_fn
+
+.. c:function:: uint32_t memcached_server_count (memcached_st *ptr)

 
 

-.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port);
+.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)

 
 

-.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port);
+.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)

 
 

-.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket);
+.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)

 
 

-.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list); 
+.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list) 

 
 

-.. c:function:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error);
+.. c:function:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)

 
 .. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr)
 
 
 .. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr)
 

-.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks);
+.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)

 
 compile and link with -lmemcached
 
 
 compile and link with -lmemcached
 


@@ -35,54 +35,55 @@ DESCRIPTION
 -----------
 
 
 -----------
 
 

-libmemcached(3) performs operations on a list of hosts. The order of these
-hosts determine routing to keys. Functions are provided to add keys to
+:doc:`libmemcached` performs operations on a list of hosts. The order of
+these hosts determine routing to keys. Functions are provided to add keys to

 memcached_st structures. To manipulate lists of servers see
 memcached_st structures. To manipulate lists of servers see

-memcached_server_st(3).
-
-memcached_server_count() provides you a count of the current number of
-servers being used by a \ ``memcached_st``\  structure.
-
-memcached_server_add() pushes a single TCP server into the \ ``memcached_st``\ 
-structure. This server will be placed at the end. Duplicate servers are
-allowed, so duplication is not checked. Executing this function with the
-\ ``MEMCACHED_BEHAVIOR_USE_UDP``\  behavior set will result in a
-\ ``MEMCACHED_INVALID_HOST_PROTOCOL``\ .
-
-memcached_server_add_udp() pushes a single UDP server into the \ ``memcached_st``\ 
-structure. This server will be placed at the end. Duplicate servers are
-allowed, so duplication is not checked. Executing this function with out
-setting the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\  behavior will result in a
-\ ``MEMCACHED_INVALID_HOST_PROTOCOL``\ .
-
-memcached_server_add_unix_socket() pushes a single UNIX socket into the
-\ ``memcached_st``\  structure. This UNIX socket will be placed at the end.
-Duplicate servers are allowed, so duplication is not checked. The length
-of the filename must be one character less then MEMCACHED_MAX_HOST_LENGTH.
-
-memcached_server_push() pushes an array of \ ``memcached_server_st``\  into
-the \ ``memcached_st``\  structure. These servers will be placed at the
-end. Duplicate servers are allowed, so duplication is not checked. A
-copy is made of structure so the list provided (and any operations on
-the list) are not saved.
-
-memcached_server_by_key() allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult \*error. The returning structure should be freed with
-memcached_server_free().
-
-memcached_server_get_last_disconnect() returns a pointer to the last server
-for which there was a connection problem. It does not mean this particular
-server is currently dead but if the library is reporting a server is,
-the returned server is a very good candidate.
-
-memcached_server_cursor() takes a memcached_st and loops through the 
-list of hosts currently in the cursor calling the list of callback 
-functions provided. You can optionally pass in a value via 
-context which will be provided to each callback function. An error
-return from any callback will terminate the loop. memcached_server_cursor()
-is passed the original caller memcached_st in its current state.
+:c:type:`memcached_server_st()`.
+
+:c:func:`memcached_server_count()` provides you a count of the current
+number of servers being used by a :c:type:`memcached_st`  structure.
+
+:c:func:`memcached_server_add()` pushes a single TCP server into the
+:c:type:`memcached_st` structure. This server will be placed at the end.
+Duplicate servers are allowed, so duplication is not checked. Executing this
+function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP`  behavior set will
+result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:c:func:`memcached_server_add_udp()` pushes a single UDP server into the
+:c:type:`memcached_st` structure. This server will be placed at the end.
+Duplicate servers are allowed, so duplication is not checked. Executing this
+function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior
+will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:c:func:`memcached_server_add_unix_socket()` pushes a single UNIX socket
+into the :c:type:`memcached_st`  structure. This UNIX socket will be placed
+at the end.  Duplicate servers are allowed, so duplication is not checked.
+The length of the filename must be one character less then
+:c:macro:`MEMCACHED_MAX_HOST_LENGTH`.
+
+:c:func:`memcached_server_push()` pushes an array of
+:c:type:`memcached_server_st` into the :c:type:`memcached_st` structure.
+These servers will be placed at the end.  Duplicate servers are allowed, so
+duplication is not checked. A copy is made of structure so the list provided
+(and any operations on the list) are not saved.
+
+:c:func:`memcached_server_by_key()` allows you to provide a key and retrieve
+the server which would be used for assignment. This structure is cloned from
+its original structure and must be freed. If NULL is returned you should
+consult \*error. The returning structure should be freed with
+:c:func:`memcached_server_free()`.
+
+:c:func:`memcached_server_get_last_disconnect()` returns a pointer to the
+last server for which there was a connection problem. It does not mean this
+particular server is currently dead but if the library is reporting a server
+is, the returned server is a very good candidate.
+
+:c:func:`memcached_server_cursor()` takes a memcached_st and loops through
+the list of hosts currently in the cursor calling the list of callback
+functions provided. You can optionally pass in a value via context which
+will be provided to each callback function. An error return from any
+callback will terminate the loop. :c:func:`memcached_server_cursor()` is
+passed the original caller memcached_st in its current state.

 
 
 ------
 
 
 ------