Merging lp:~brianaker/libmemcached/rpm-mkdir-fix to Build branch

[m6w6/libmemcached] / docs / man / memcached_servers_parse.3

diff --git a/docs/man/memcached_servers_parse.3 b/docs/man/memcached_servers_parse.3
index 9910686ce4a70315dff6aa07651320792035e8bc..11c46157e1bc860fb2caef20fd4ac7a2770ca874 100644 (file)
--- a/docs/man/memcached_servers_parse.3
+++ b/docs/man/memcached_servers_parse.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_SERVERS_PARSE" "3" "June 02, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_SERVERS_PARSE" "3" "May 31, 2012" "1.0.8" "libmemcached"

 .SH NAME
 memcached_servers_parse \- libmemcached Documentation
 .
 .SH NAME
 memcached_servers_parse \- libmemcached Documentation
 .


@@ -35,57 +35,72 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP
 #include <libmemcached/memcached.h>
 .INDENT 0.0
 .TP

-.B const memcached_server_instance_st memcached_server_list (memcached_st *ptr);
+.B memcached_server_instance_st

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B void memcached_server_list_free (memcached_server_list_st list);
+.B memcached_server_list_st

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error);
+.B memcached_server_st

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B uint32_t memcached_server_list_count (memcached_server_list_st list);
+.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B const char *memcached_server_error (memcached_server_instance_st instance);
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)

 .UNINDENT
 .INDENT 0.0
 .TP
 .UNINDENT
 .INDENT 0.0
 .TP

-.B void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)

 .UNINDENT
 .UNINDENT

+.INDENT 0.0
+.TP
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B const char *memcached_server_error(\fI\%memcached_server_instance_st\fP\fI\ instance\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void memcached_server_error_reset(\fI\%memcached_server_instance_st\fP\fI\ list\fP)
+.UNINDENT
+.sp
+Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.

 .sp
 Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 libmemcached(3) operates on a list of hosts which are stored in
 .sp
 Compile and link with \-lmemcached
 .SH DESCRIPTION
 .sp
 libmemcached(3) operates on a list of hosts which are stored in

-memcached_server_st structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures

 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 .sp
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 .sp

-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.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.

 .sp
 .sp

-memcached_server_list_free() deallocates all memory associated with the array
-of memcached_server_st that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.

 .sp
 .sp

-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
+\fI\%memcached_server_list_append()\fP adds a server to the end of a
+\fI\%memcached_server_st\fP array. On error null will be returned and the
+\fBmemcached_return_t\fP 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.
 .sp
 port of a memcached server.
 .sp

-DEPRECATED memcached_servers_parse(), please see \fImemcached(3)\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP

 .sp
 .sp

-memcached_server_error() can be used to look at the text of the last error
-message sent by the server to to the client.
+\fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.

 .sp
 Before version 0.39 theses functions used a memcache_server_st *. In 0.39
 .sp
 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
-done for a style reason/to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.

 .SH RETURN
 .sp
 Varies, see particular functions.
 .SH RETURN
 .sp
 Varies, see particular functions.