X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_server_st.rst;h=9a8c8fc2d1d1a27bc2f9f62c41586e5473779fc2;hb=db154fa6dbcd3bb64f16669df2f24abf80e49296;hp=e7ec65c97ac938d225080299f79dbdd5046e4750;hpb=625e84ebfc422790372bc2984f504bdcb4da779c;p=m6w6%2Flibmemcached diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst index e7ec65c9..9a8c8fc2 100644 --- a/docs/memcached_server_st.rst +++ b/docs/memcached_server_st.rst @@ -36,30 +36,25 @@ DESCRIPTION libmemcached(3) operates on a list of hosts which are stored in -memcached_server_st structures. You should not modify these structures +:c:type:`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!). -: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. +: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. -:c:func:`memcached_server_list_free()` deallocates all memory associated with the array -of memcached_server_st that you passed to it. +:c:func:`memcached_server_list_free()` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it. :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 +:c:type:`memcached_server_st` array. On error null will be returned and the +:c:type:`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 :c:func:`memcached_servers_parse()`, please see :c:func:`memcached()` -: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. +: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. -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. +Before version 0.39 theses 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. ------