From 9d8ad7151bed36742138f7422307d19d0d64373c Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Mon, 24 Feb 2020 13:20:48 +0100 Subject: [PATCH] docs: sanitize --- docs/source/bin/memaslap.rst | 4 +- docs/source/bin/memcapable.rst | 4 +- docs/source/bin/memcat.rst | 3 +- docs/source/bin/memcp.rst | 3 +- docs/source/bin/memdump.rst | 4 +- docs/source/bin/memerror.rst | 3 +- docs/source/bin/memexist.rst | 3 +- docs/source/bin/memflush.rst | 4 +- docs/source/bin/memparse.rst | 3 +- docs/source/bin/memping.rst | 4 +- docs/source/bin/memrm.rst | 3 +- docs/source/bin/memslap.rst | 3 +- docs/source/bin/memstat.rst | 3 +- docs/source/bin/memtouch.rst | 3 +- docs/source/conf.py.in | 12 ++ docs/source/hashkit_create.rst | 35 ++-- docs/source/hashkit_function.rst | 62 +++++++ docs/source/hashkit_functions.rst | 36 ++--- docs/source/hashkit_value.rst | 33 ++-- docs/source/index.rst | 1 + docs/source/libhashkit.rst | 35 ++-- .../memcached_set_encoding_key.rst | 4 +- .../libmemcached-1.0/memcached_touch.rst | 4 +- docs/source/libmemcached.rst | 151 +++++++++++++----- docs/source/libmemcached/memcached_exist.rst | 3 +- docs/source/libmemcached/memcached_fetch.rst | 4 +- .../memcached_last_error_message.rst | 4 +- .../libmemcached/memcached_return_t.rst | 4 +- docs/source/libmemcached_configuration.rst | 23 +-- docs/source/libmemcached_examples.rst | 1 - docs/source/libmemcachedutil.rst | 26 +-- docs/source/memcached_analyze.rst | 3 +- docs/source/memcached_append.rst | 3 +- docs/source/memcached_auto.rst | 3 +- docs/source/memcached_behavior.rst | 3 +- docs/source/memcached_callback.rst | 3 +- docs/source/memcached_cas.rst | 3 +- docs/source/memcached_create.rst | 3 +- docs/source/memcached_delete.rst | 4 +- docs/source/memcached_dump.rst | 3 +- docs/source/memcached_flush.rst | 4 +- docs/source/memcached_flush_buffers.rst | 3 +- docs/source/memcached_generate_hash_value.rst | 3 +- docs/source/memcached_get.rst | 4 +- docs/source/memcached_memory_allocators.rst | 4 +- docs/source/memcached_pool.rst | 80 +++++++--- docs/source/memcached_quit.rst | 4 +- docs/source/memcached_result_st.rst | 4 +- docs/source/memcached_sasl.rst | 3 +- docs/source/memcached_server_st.rst | 3 +- docs/source/memcached_servers.rst | 3 +- docs/source/memcached_set.rst | 3 +- docs/source/memcached_stats.rst | 3 +- docs/source/memcached_strerror.rst | 3 +- docs/source/memcached_user_data.rst | 3 +- docs/source/memcached_verbosity.rst | 3 +- docs/source/memcached_version.rst | 3 +- include/libhashkit-1.0/CMakeLists.txt | 4 +- 58 files changed, 448 insertions(+), 202 deletions(-) create mode 100644 docs/source/hashkit_function.rst diff --git a/docs/source/bin/memaslap.rst b/docs/source/bin/memaslap.rst index eae05d81..f323e524 100644 --- a/docs/source/bin/memaslap.rst +++ b/docs/source/bin/memaslap.rst @@ -1229,4 +1229,6 @@ memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst index f5d18c28..da1a2e6c 100644 --- a/docs/source/bin/memcapable.rst +++ b/docs/source/bin/memcapable.rst @@ -56,5 +56,7 @@ Set the timeout from an IO operation to/from the server to \ *n*\ seconds. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst index 3345a0b6..00773ee0 100644 --- a/docs/source/bin/memcat.rst +++ b/docs/source/bin/memcat.rst @@ -49,6 +49,7 @@ For a full list of operations run the tool with the option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst index d9547d91..a60008be 100644 --- a/docs/source/bin/memcp.rst +++ b/docs/source/bin/memcp.rst @@ -52,6 +52,7 @@ For a full list of operations run the tool with the option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memdump.rst b/docs/source/bin/memdump.rst index 7ea39bcd..8510605a 100644 --- a/docs/source/bin/memdump.rst +++ b/docs/source/bin/memdump.rst @@ -39,4 +39,6 @@ For a full list of operations run the tool with option: SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memerror.rst b/docs/source/bin/memerror.rst index b92699fe..2a630060 100644 --- a/docs/source/bin/memerror.rst +++ b/docs/source/bin/memerror.rst @@ -38,5 +38,6 @@ For a full list of operations run the tool with option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memexist.rst b/docs/source/bin/memexist.rst index b407d90c..fd23a80b 100644 --- a/docs/source/bin/memexist.rst +++ b/docs/source/bin/memexist.rst @@ -43,6 +43,7 @@ For a full list of operations run the tool with the option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst index 9caa422e..06a5d4d7 100644 --- a/docs/source/bin/memflush.rst +++ b/docs/source/bin/memflush.rst @@ -46,4 +46,6 @@ For a full list of operations run the tool with option: SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memparse.rst b/docs/source/bin/memparse.rst index eb535ecf..926a97b5 100644 --- a/docs/source/bin/memparse.rst +++ b/docs/source/bin/memparse.rst @@ -36,6 +36,7 @@ For a full list of operations run the tool with the option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memping.rst b/docs/source/bin/memping.rst index f3c8dce4..5fdfef70 100644 --- a/docs/source/bin/memping.rst +++ b/docs/source/bin/memping.rst @@ -43,4 +43,6 @@ For a full list of operations run the tool with the option: SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memrm.rst b/docs/source/bin/memrm.rst index 1211043d..783961b4 100644 --- a/docs/source/bin/memrm.rst +++ b/docs/source/bin/memrm.rst @@ -47,6 +47,7 @@ For a full list of operations run the tool with the SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memslap.rst b/docs/source/bin/memslap.rst index 8abd7fe0..80ac2526 100644 --- a/docs/source/bin/memslap.rst +++ b/docs/source/bin/memslap.rst @@ -43,5 +43,6 @@ For a full list of operations run the tool with: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memstat.rst b/docs/source/bin/memstat.rst index a958d902..e3193de9 100644 --- a/docs/source/bin/memstat.rst +++ b/docs/source/bin/memstat.rst @@ -49,6 +49,7 @@ For a full list of operations run the tool with: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memtouch.rst b/docs/source/bin/memtouch.rst index 44b4c085..50e92415 100644 --- a/docs/source/bin/memtouch.rst +++ b/docs/source/bin/memtouch.rst @@ -44,6 +44,7 @@ For a full list of operations run the tool with the option: SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/conf.py.in b/docs/source/conf.py.in index d0ebde0f..ad18ec83 100644 --- a/docs/source/conf.py.in +++ b/docs/source/conf.py.in @@ -44,6 +44,13 @@ man_pages = [ ('hashkit_create' , 'hashkit_create' , u'libhashkit Documentation' , man_authors, 3), ('hashkit_create' , 'hashkit_free' , u'libhashkit Documentation' , man_authors, 3), ('hashkit_create' , 'hashkit_is_allocated' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_function' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_get_distribution_function' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_get_function' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_set_function' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_set_custom_distribution_function',u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_set_custom_function' , u'libhashkit Documentation' , man_authors, 3), + ('hashkit_function' , 'hashkit_set_distribution_function' , u'libhashkit Documentation' , man_authors, 3), ('hashkit_functions' , 'hashkit_crc32' , u'libhashkit Documentation' , man_authors, 3), ('hashkit_functions' , 'hashkit_fnv1_32' , u'libhashkit Documentation' , man_authors, 3), ('hashkit_functions' , 'hashkit_fnv1_64' , u'libhashkit Documentation' , man_authors, 3), @@ -183,4 +190,9 @@ man_pages = [ ('bin/memtouch' , 'memtouch' , u'libmemcached Documentation' , man_authors, 1), ] +rst_prolog = """ +.. |libhashkit_version| replace:: @LIBHASHKIT_VERSION_MAJOR@.@LIBHASHKIT_VERSION_MINOR@ +.. |libmemcached_version| replace:: @LIBMEMCACHED_VERSION_MAJOR@.@LIBMEMCACHED_VERSION_MINOR@ +""" + @SPHINX_CONF_APPEND@ diff --git a/docs/source/hashkit_create.rst b/docs/source/hashkit_create.rst index 5473ba11..47371eca 100644 --- a/docs/source/hashkit_create.rst +++ b/docs/source/hashkit_create.rst @@ -1,18 +1,19 @@ -============================ Creating a hashkit structure ============================ -.. highlightlang:: c - .. index:: object: hashkit_st --------- +Create, copy and free a hashkit structure + SYNOPSIS -------- -.. describe:: #include - -.. c:type:: hashkit_st +#include + Compile and link with -lhashkit + +.. c:type:: struct hashkit_st + + typedef struct hashkit_st hashkit_st; .. c:function:: hashkit_st *hashkit_create(hashkit_st *hash) @@ -22,13 +23,9 @@ SYNOPSIS .. c:function:: bool hashkit_is_allocated(const hashkit_st *hash) -Compile and link with -lhashkit - ------------ DESCRIPTION ----------- - The :c:func:`hashkit_create` function initializes a hashkit object for use. If you pass a NULL argument for hash, then the memory for the object is allocated. If you specify a pre-allocated piece of memory, that is @@ -44,12 +41,9 @@ objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_ The :c:func:`hashkit_is_allocated` reports where the memory was allocated for a hashkit object. - ------------- RETURN VALUE ------------ - :c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on failure or non-NULL on success. @@ -57,12 +51,17 @@ failure or non-NULL on success. object was allocated inside of :c:func:`hashkit_create` or :c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory. - - --------- SEE ALSO -------- +.. only:: man + + :manpage:`libhashkit(3)` + :manpage:`hashkit_value(3)` + :manpage:`hashkit_function3)` -:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` +.. only:: html + * :doc:`libhashkit` + * :doc:`hashkit_value` + * :doc:`hashkit_function` diff --git a/docs/source/hashkit_function.rst b/docs/source/hashkit_function.rst new file mode 100644 index 00000000..b32c77aa --- /dev/null +++ b/docs/source/hashkit_function.rst @@ -0,0 +1,62 @@ +Set Hash Function +================= + +.. index:: object: hashkit_st +.. index:: object: hashkit_hash_fn + +Set hash functions to use for calculating values for keys + +SYNOPSIS +-------- + +#include + Compile and link with -lhashkit + +.. c:type:: hashkit_hash_fn + +.. code-block:: c + + typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context); + +.. c:function:: hashkit_return_t hashkit_set_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm) + +.. c:function:: hashkit_return_t hashkit_set_custom_function(hashkit_st *hash, hashkit_hash_fn function, void *context) + +.. c:function:: hashkit_hash_algorithm_t hashkit_get_function(const hashkit_st *hash) + +.. c:function:: hashkit_return_t hashkit_set_distribution_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm) + +.. c:function:: hashkit_return_t hashkit_set_custom_distribution_function(hashkit_st *self, hashkit_hash_fn function, void *context) + +.. c:function:: hashkit_hash_algorithm_t hashkit_get_distribution_function(const hashkit_st *self) + +DESCRIPTION +----------- + +These functions are used to set and retrieve the key and distribution hash functions. + + +RETURN VALUE +------------ + +:c:func:`hashkit_set_function`, :c:func:`hashkit_set_custom_function` and the distribution equivalents +return :c:type:`hashkit_return_t` `HASHKIT_SUCCESS` on success. + +:c:func:`hashkit_get_function` and :c:func:`hashkit_get_distribution_function` return :c:type:`hashkit_hash_algorithm_t` +indicating the hash function used. + +SEE ALSO +-------- + +.. only:: man + + :manpage:`libhashkit(3)` + :manpage:`hashkit_create(3)` + :manpage:`hashkit_functions(3)` + +.. only:: html + + * :doc:`libhashkit` + * :doc:`hashkit_create` + * :doc:`hashkit_functions` + diff --git a/docs/source/hashkit_functions.rst b/docs/source/hashkit_functions.rst index 0c9e2cc1..d6225d4e 100644 --- a/docs/source/hashkit_functions.rst +++ b/docs/source/hashkit_functions.rst @@ -1,4 +1,3 @@ -================ Available Hashes ================ @@ -6,13 +5,12 @@ Available Hashes Various hash functions to use for calculating values for keys - --------- SYNOPSIS -------- -#include - +#include + Compile and link with -lhashkit + .. c:function:: uint32_t hashkit_default(const char *key, size_t key_length) .. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length) @@ -29,39 +27,39 @@ SYNOPSIS .. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length) +.. c:function:: uint32_t hashkit_murmur3(const char *key, size_t key_length) + .. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length) .. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length) -Compile and link with -lhashkit - - ------------ DESCRIPTION ----------- - These functions generate hash values from a key using a variety of algorithms. These functions can be used standalone, or as arguments -to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3). +to :c:func:`hashkit_set_hash_fn` or :c:func:`hashkit_set_continuum_hash_fn`. -The hashkit_hsieh is only available if the library is built with +The :c:func:`hashkit_hsieh` is only available if the library is built with the appropriate flag enabled. - ------------- RETURN VALUE ------------ - A 32-bit hash value. - - --------- SEE ALSO -------- +.. only:: man + + :manpage:`libhashkit(3)` + :manpage:`hashkit_create(3)` + :manpage:`hashkit_function(3)` + +.. only:: html -:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)` + * :doc:`libhashkit` + * :doc:`hashkit_create` + * :doc:`hashkit_function` diff --git a/docs/source/hashkit_value.rst b/docs/source/hashkit_value.rst index cae79ace..a70e8963 100644 --- a/docs/source/hashkit_value.rst +++ b/docs/source/hashkit_value.rst @@ -1,46 +1,45 @@ -============= -hashkit_value -============= - +Generate hash value +=================== .. index:: object: hashkit_st Generate a value for the given key --------- SYNOPSIS -------- - -#include +#include + Compile and link with -lhashkit .. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length) - -Compile and link with -lhashkit ------------ DESCRIPTION ----------- - The :c:func:`hashkit_value` function generates a 32-bit hash value from the given key and key_length. The hash argument is an initialized hashkit object, and distribution type and hash function is used from this object while generating the value. - ------------- RETURN VALUE ------------ - A 32-bit hash value. - --------- SEE ALSO -------- +.. only:: man + + :manpage:`libhashkit(3)` + :manpage:`hashkit_create(3)` + :manpage:`hashkit_function(3)` + :manpage:`hashkit_functions(3)` + +.. only:: html -:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)` + * :doc:`libhashkit` + * :doc:`hashkit_create` + * :doc:`hashkit_function` + * :doc:`hashkit_functions` diff --git a/docs/source/index.rst b/docs/source/index.rst index 3a4e1c61..d52d601c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -113,6 +113,7 @@ Libmemcached libhashkit hashkit_create + hashkit_function hashkit_functions hashkit_value diff --git a/docs/source/libhashkit.rst b/docs/source/libhashkit.rst index 5e6e28a5..755f7b9a 100644 --- a/docs/source/libhashkit.rst +++ b/docs/source/libhashkit.rst @@ -1,28 +1,35 @@ -====================== Introducing libhashkit ====================== +SYNOPSIS +-------- -.. code-block:: c - - cc [ flag ... ] file ... -lhashkit - - #include - - +#include + Compile and link with -lhashkit. ------------ DESCRIPTION ----------- +libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm. -libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm. libhashkit is distributed with libmemcached. +libhashkit is distributed with libmemcached. - - --------- SEE ALSO -------- -:manpage:`libhashkit(3)` +.. only:: man + + :manpage:`libmemcached(3)` + :manpage:`hashkit_create(3)` + :manpage:`hashkit_function(3)` + :manpage:`hashkit_functions(3)` + :manpage:`hashkit_value(3)` + +.. only:: html + + * :doc:`libmemcached` + * :doc:`hashkit_create` + * :doc:`hashkit_function` + * :doc:`hashkit_functions` + * :doc:`hashkit_value` diff --git a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst index 4e79f43f..aa184e78 100644 --- a/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst +++ b/docs/source/libmemcached-1.0/memcached_set_encoding_key.rst @@ -39,4 +39,6 @@ translate this value to a printable string. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/libmemcached-1.0/memcached_touch.rst b/docs/source/libmemcached-1.0/memcached_touch.rst index 6c1b931b..70a71be3 100644 --- a/docs/source/libmemcached-1.0/memcached_touch.rst +++ b/docs/source/libmemcached-1.0/memcached_touch.rst @@ -43,5 +43,7 @@ string. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/libmemcached.rst b/docs/source/libmemcached.rst index 4de8d579..c78aa95e 100644 --- a/docs/source/libmemcached.rst +++ b/docs/source/libmemcached.rst @@ -7,12 +7,12 @@ SYNOPSIS -------- #include - -Compile and link with -lmemcached + Compile and link with -lmemcached ======= -libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods. +libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). +It has been designed to be light on memory usage, thread safe, and provide full access to server side methods. libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided: @@ -53,7 +53,8 @@ Nearly all functions return a :c:type:`memcached_return_t` value. This value can be translated to a printable string with :c:type:`memcached_strerror`. -Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server. +Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. +All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server. Group keys can be optionally used to group sets of objects with servers. @@ -73,8 +74,6 @@ AC_SUBST(DEPS_LIBS) Some features of the library must be enabled through :c:func:`memcached_behavior_set`. -Hope you enjoy it! - --------- CONSTANTS @@ -142,36 +141,110 @@ you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use t SEE ALSO -------- - -:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` -:manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` -:manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` -:manpage:`memstat(1)` :manpage:`memcached_fetch(3)` -:manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` -:manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` -:manpage:`memcached_free(3)` :manpage:`memcached_server_add(3)` -:manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` -:manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` -:manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` -:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)` -:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` -:manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` -:manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` -:manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` -:manpage:`memcached_server_add_unix_socket(3)` -:manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)` -:manpage:`memcached_result_key_value(3)` -:manpage:`memcached_result_key_length(3)` -:manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)` -:manpage:`memcached_result_flags(3)` :manpage:`memcached_result_cas(3)` -:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` -:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)` -:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` -:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)` -:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` -:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)` -:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` -:manpage:`memcached_dump(3)` :manpage:`memdump(1)` -:manpage:`memcached_set_memory_allocators(3)` -:manpage:`memcached_get_memory_allocators(3)` -:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)` +.. only:: man + + :manpage:`memcached(1)` + :manpage:`memaslap(1)` + :manpage:`memcapable(1)` + :manpage:`memcat(1)` + :manpage:`memcp(1)` + :manpage:`memdump(1)` + :manpage:`memerror(1)` + :manpage:`memexist(1)` + :manpage:`memflush(1)` + :manpage:`memparse(1)` + :manpage:`memping(1)` + :manpage:`memrm(1)` + :manpage:`memslap(1)` + :manpage:`memstat(1)` + :manpage:`memtouch(1)` + :manpage:`libhashkit(3)` + :manpage:`libmemcached_configuration(3)` + :manpage:`libmemcached_examples(3)` + :manpage:`libmemcachedutil(3)` + :manpage:`memcached_analyze(3)` + :manpage:`memcached_append(3)` + :manpage:`memcached_auto(3)` + :manpage:`memcached_behavior(3)` + :manpage:`memcached_callback(3)` + :manpage:`memcached_cas(3)` + :manpage:`memcached_create(3)` + :manpage:`memcached_delete(3)` + :manpage:`memcached_dump(3)` + :manpage:`memcached_exist(3)` + :manpage:`memcached_fetch(3)` + :manpage:`memcached_flush(3)` + :manpage:`memcached_flush_buffers(3)` + :manpage:`memcached_generate_hash_value(3)` + :manpage:`memcached_get(3)` + :manpage:`memcached_last_error_message(3)` + :manpage:`memcached_memory_allocators(3)` + :manpage:`memcached_pool(3)` + :manpage:`memcached_quit(3)` + :manpage:`memcached_result_st(3)` + :manpage:`memcached_return_t(3)` + :manpage:`memcached_sasl(3)` + :manpage:`memcached_servers(3)` + :manpage:`memcached_server_st(3)` + :manpage:`memcached_set(3)` + :manpage:`memcached_set_encoding_key(3)` + :manpage:`memcached_stats(3)` + :manpage:`memcached_strerror(3)` + :manpage:`memcached_touch(3)` + :manpage:`memcached_user_data(3)` + :manpage:`memcached_verbosity(3)` + :manpage:`memcached_version(3)` + +.. only:: html + + * :manpage:`memcached(1)` + * :doc:`bin/memaslap` + * :doc:`bin/memcapable` + * :doc:`bin/memcat` + * :doc:`bin/memcp` + * :doc:`bin/memdump` + * :doc:`bin/memerror` + * :doc:`bin/memexist` + * :doc:`bin/memflush` + * :doc:`bin/memparse` + * :doc:`bin/memping` + * :doc:`bin/memrm` + * :doc:`bin/memslap` + * :doc:`bin/memstat` + * :doc:`bin/memtouch` + * :doc:`libhashkit` + * :doc:`libmemcached_configuration` + * :doc:`libmemcached_examples` + * :doc:`libmemcachedutil` + * :doc:`memcached_analyze` + * :doc:`memcached_append` + * :doc:`memcached_auto` + * :doc:`memcached_behavior` + * :doc:`memcached_callback` + * :doc:`memcached_cas` + * :doc:`memcached_create` + * :doc:`memcached_delete` + * :doc:`memcached_dump` + * :doc:`libmemcached/memcached_exist` + * :doc:`libmemcached/memcached_fetch` + * :doc:`memcached_flush` + * :doc:`memcached_flush_buffers` + * :doc:`memcached_generate_hash_value` + * :doc:`memcached_get` + * :doc:`libmemcached/memcached_last_error_message` + * :doc:`memcached_memory_allocators` + * :doc:`memcached_pool` + * :doc:`memcached_quit` + * :doc:`memcached_result_st` + * :doc:`libmemcached/memcached_return_t` + * :doc:`memcached_sasl` + * :doc:`memcached_servers` + * :doc:`memcached_server_st` + * :doc:`memcached_set` + * :doc:`libmemcached-1.0/memcached_set_encoding_key` + * :doc:`memcached_stats` + * :doc:`memcached_strerror` + * :doc:`libmemcached-1.0/memcached_touch` + * :doc:`memcached_user_data` + * :doc:`memcached_verbosity` + * :doc:`memcached_version` diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst index 4bcd6934..3e4a8e77 100644 --- a/docs/source/libmemcached/memcached_exist.rst +++ b/docs/source/libmemcached/memcached_exist.rst @@ -41,7 +41,8 @@ RETURN SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst index 0a9cd30c..3fd638f1 100644 --- a/docs/source/libmemcached/memcached_fetch.rst +++ b/docs/source/libmemcached/memcached_fetch.rst @@ -54,5 +54,7 @@ key allowed for the original memcached ascii server. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)` diff --git a/docs/source/libmemcached/memcached_last_error_message.rst b/docs/source/libmemcached/memcached_last_error_message.rst index 0995550b..5ae3188d 100644 --- a/docs/source/libmemcached/memcached_last_error_message.rst +++ b/docs/source/libmemcached/memcached_last_error_message.rst @@ -35,6 +35,8 @@ de-allocated. If no error has occurred then it will return NULL. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/libmemcached/memcached_return_t.rst b/docs/source/libmemcached/memcached_return_t.rst index b60e2841..d2b99180 100644 --- a/docs/source/libmemcached/memcached_return_t.rst +++ b/docs/source/libmemcached/memcached_return_t.rst @@ -121,4 +121,6 @@ Libmemcached return types: SEE ALSO -------- -:manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_str_error` +.. only:: man + + :manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_str_error` diff --git a/docs/source/libmemcached_configuration.rst b/docs/source/libmemcached_configuration.rst index c8c018e2..1602f97d 100644 --- a/docs/source/libmemcached_configuration.rst +++ b/docs/source/libmemcached_configuration.rst @@ -8,16 +8,12 @@ Configuring Libmemcached SYNOPSIS -------- -.. describe:: #include +#include + Compile and link with -lmemcached -.. c:function:: memcached_st *\ - memcached(const char *string, size_t string_length) +.. c:function:: memcached_st *memcached(const char *string, size_t string_length) -.. c:function:: memcached_return_t \ - libmemcached_check_configuration(const char *option_string, size_t length, \ - char *error_buffer, size_t error_buffer_size) - -Compile and link with -lmemcached +.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size) ----------- @@ -231,5 +227,14 @@ EXAMPLE SEE ALSO -------- +.. only:: man + + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`memcached_strerror(3)` + +.. only:: html -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + * :manpage:`memcached(1)` + * :doc:`libmemcached` + * :doc:`memcached_strerror` diff --git a/docs/source/libmemcached_examples.rst b/docs/source/libmemcached_examples.rst index 014a677e..d3b0876f 100644 --- a/docs/source/libmemcached_examples.rst +++ b/docs/source/libmemcached_examples.rst @@ -130,6 +130,5 @@ Notice that you freed values returned from memcached_fetch(). The define SEE ALSO -------- - :manpage:`memcached(1)` diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst index 9c869175..530043ed 100644 --- a/docs/source/libmemcachedutil.rst +++ b/docs/source/libmemcachedutil.rst @@ -10,12 +10,8 @@ Utility library for libmemcached SYNOPSIS -------- -.. code-block:: c - - cc [ flag ... ] file ... -lmemcachedutil - - #include - +#include + Compile and link with -lmemcachedutil ----------- @@ -23,24 +19,32 @@ DESCRIPTION ----------- -:program:`libmemcachedutil` is a small and thread-safe client library that -provides extra functionality built on top of :program:`libmemcached`. +`libmemcachedutil` is a small and thread-safe client library that +provides extra functionality built on top of `libmemcached`. ------- THREADS ------- - Do not try to access an instance of :c:type:`memcached_st` from multiple threads at the same time. If you want to access memcached from multiple threads you should either clone the :c:type:`memcached_st`, or use the memcached pool -implementation. see :c:func:`memcached_pool_create`. +implementation. See :c:func:`memcached_pool_create`. -------- SEE ALSO -------- +.. only:: man + + :manpage:`libmemcached(3)` + :manpage:`memcached_pool(3)` + :manpage:`memcached_pool_destroy(3)` + :manpage:`memcached_pool_pop(3)` + :manpage:`memcached_pool_push(3)` -:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)` +.. only:: html + * :doc:`libmemcached` + * :doc:`memcached_pool` diff --git a/docs/source/memcached_analyze.rst b/docs/source/memcached_analyze.rst index 0aa85216..50e3ee1b 100644 --- a/docs/source/memcached_analyze.rst +++ b/docs/source/memcached_analyze.rst @@ -56,6 +56,7 @@ memory allocated for it. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_append.rst b/docs/source/memcached_append.rst index 0f458111..12314af4 100644 --- a/docs/source/memcached_append.rst +++ b/docs/source/memcached_append.rst @@ -89,6 +89,7 @@ string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)` diff --git a/docs/source/memcached_auto.rst b/docs/source/memcached_auto.rst index f72e698a..22b95621 100644 --- a/docs/source/memcached_auto.rst +++ b/docs/source/memcached_auto.rst @@ -85,5 +85,6 @@ Use memcached_strerror to translate this value to a printable string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_behavior.rst b/docs/source/memcached_behavior.rst index 87f95886..9f189ba4 100644 --- a/docs/source/memcached_behavior.rst +++ b/docs/source/memcached_behavior.rst @@ -329,5 +329,6 @@ to data value, to taking a uin64_t. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_callback.rst b/docs/source/memcached_callback.rst index 8e32d907..7cccb773 100644 --- a/docs/source/memcached_callback.rst +++ b/docs/source/memcached_callback.rst @@ -137,5 +137,6 @@ successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_cas.rst b/docs/source/memcached_cas.rst index 13b8842d..b3cbddba 100644 --- a/docs/source/memcached_cas.rst +++ b/docs/source/memcached_cas.rst @@ -65,6 +65,7 @@ string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)` diff --git a/docs/source/memcached_create.rst b/docs/source/memcached_create.rst index 246a33d2..a9ac137d 100644 --- a/docs/source/memcached_create.rst +++ b/docs/source/memcached_create.rst @@ -70,5 +70,6 @@ that was created (or initialized). On an allocation failure, it returns NULL. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_delete.rst b/docs/source/memcached_delete.rst index 493355da..5daefaec 100644 --- a/docs/source/memcached_delete.rst +++ b/docs/source/memcached_delete.rst @@ -54,4 +54,6 @@ means that the message was queued for delivery. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_dump.rst b/docs/source/memcached_dump.rst index bee396df..5959cec8 100644 --- a/docs/source/memcached_dump.rst +++ b/docs/source/memcached_dump.rst @@ -52,5 +52,6 @@ string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_flush.rst b/docs/source/memcached_flush.rst index c2ac60f5..94612f4a 100644 --- a/docs/source/memcached_flush.rst +++ b/docs/source/memcached_flush.rst @@ -46,4 +46,6 @@ Use :c:type:`memcached_strerror` to translate this value to a printable string. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_flush_buffers.rst b/docs/source/memcached_flush_buffers.rst index 0c92d3a2..4e172006 100644 --- a/docs/source/memcached_flush_buffers.rst +++ b/docs/source/memcached_flush_buffers.rst @@ -44,5 +44,6 @@ string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_generate_hash_value.rst b/docs/source/memcached_generate_hash_value.rst index 4a81a8d0..413a7292 100644 --- a/docs/source/memcached_generate_hash_value.rst +++ b/docs/source/memcached_generate_hash_value.rst @@ -82,5 +82,6 @@ returned. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_get.rst b/docs/source/memcached_get.rst index 4ece04e5..8c478ce9 100644 --- a/docs/source/memcached_get.rst +++ b/docs/source/memcached_get.rst @@ -120,4 +120,6 @@ to :c:type:`MEMCACHED_END` upon successful conclusion. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_memory_allocators.rst b/docs/source/memcached_memory_allocators.rst index 6ed8ae3d..0df7d70c 100644 --- a/docs/source/memcached_memory_allocators.rst +++ b/docs/source/memcached_memory_allocators.rst @@ -81,4 +81,6 @@ of function pointers. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_pool.rst b/docs/source/memcached_pool.rst index 04492444..c28fbf38 100644 --- a/docs/source/memcached_pool.rst +++ b/docs/source/memcached_pool.rst @@ -7,30 +7,20 @@ SYNOPSIS -------- #include + Compile and link with -lmemcachedutil -lmemcached -.. c:type:: memcached_pool_st +.. c:type:: struct memcached_pool_st + + typedef struct memcached_pool_st memcached_pool_st; .. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length) -.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max) -.. deprecated:: 0.46 - Use :c:func:`memcached_pool` - .. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool) -.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc) -.. deprecated:: 0.53 - Use :c:func:`memcached_pool_fetch` - .. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc) - .. versionadded:: 0.53 Synonym for memcached_pool_pop -.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc) -.. deprecated:: 0.53 - Use :c:func:`memcached_pool_push` - .. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc) .. versionadded:: 0.53 Synonym for memcached_pool_push. @@ -39,7 +29,19 @@ SYNOPSIS .. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -Compile and link with -lmemcachedutil -lmemcached + +.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max) +.. deprecated:: 0.46 + Use :c:func:`memcached_pool` + +.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc) +.. deprecated:: 0.53 + Use :c:func:`memcached_pool_fetch` + +.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc) +.. deprecated:: 0.53 + Use :c:func:`memcached_pool_release` + ----------- DESCRIPTION @@ -48,39 +50,53 @@ DESCRIPTION :c:func:`memcached_pool` is used to create a connection pool of objects you may use to remove the overhead of using memcached_clone for short lived -:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string. +:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` +for details on the format of the configuration string. :c:func:`memcached_pool_destroy` is used to destroy the connection pool created with :c:func:`memcached_pool_create` and release all allocated resources. It will return the pointer to the :c:type:`memcached_st` structure -passed as an argument to :c:func:`memcached_pool_create`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create`, otherwise NULL is returned.. +passed as an argument to :c:func:`memcached_pool_create`, and returns the +ownership of the pointer to the caller when created with +:c:func:`memcached_pool_create`, otherwise NULL is returned.. :c:func:`memcached_pool_fetch` is used to fetch a connection structure from the connection pool. The relative_time argument specifies if the function should block and wait for a connection structure to be available if we try to exceed the maximum size. You need to specify time in relative time. -:c:func:`memcached_pool_release` is used to return a connection structure back to the pool. +:c:func:`memcached_pool_release` is used to return a connection structure back +to the pool. -:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` is used to get/set behavior flags on all connections in the pool. +:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set` +is used to get/set behavior flags on all connections in the pool. -Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe. +Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are +thread safe. ------ RETURN ------ -:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL. +:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the +:c:type:`memcached_st` structure used to create the pool. If connections are in +use it returns NULL. -:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied). +:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st` +structure from the pool (or NULL if an allocation cannot be satisfied). :c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success. -:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success. +:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` +returns :c:type:`MEMCACHED_SUCCESS` upon success. -If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned. +If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not +be obtained. If any of the parameters passed to any of these functions is +invalid, MEMCACHED_INVALID_ARGUMENTS will be returned. -memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available. +memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while +waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was +available. @@ -88,4 +104,16 @@ memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while wait SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)` +.. only:: man + + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`libmemcached_configuration(3)` + :manpage:`memcached_strerror(3)` + +.. only:: html + + * :manpage:`memcached(1)` + * :doc:`libmemcached` + * :doc:`libmemcached_configuration` + * :doc:`memcached_strerror` diff --git a/docs/source/memcached_quit.rst b/docs/source/memcached_quit.rst index 9f79a79b..f4ffc17a 100644 --- a/docs/source/memcached_quit.rst +++ b/docs/source/memcached_quit.rst @@ -43,4 +43,6 @@ translate this value to a printable string. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_result_st.rst b/docs/source/memcached_result_st.rst index 40e1ad86..124d20e7 100644 --- a/docs/source/memcached_result_st.rst +++ b/docs/source/memcached_result_st.rst @@ -114,4 +114,6 @@ to do this will result in leaked memory. SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +.. only:: man + + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_sasl.rst b/docs/source/memcached_sasl.rst index ff2dad31..1a76aa41 100644 --- a/docs/source/memcached_sasl.rst +++ b/docs/source/memcached_sasl.rst @@ -58,5 +58,6 @@ this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_server_st.rst b/docs/source/memcached_server_st.rst index dbbaf03d..dd9e7bfb 100644 --- a/docs/source/memcached_server_st.rst +++ b/docs/source/memcached_server_st.rst @@ -76,5 +76,6 @@ Varies, see particular functions. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_servers.rst b/docs/source/memcached_servers.rst index 2aea068d..7ebb523d 100644 --- a/docs/source/memcached_servers.rst +++ b/docs/source/memcached_servers.rst @@ -86,5 +86,6 @@ Varies, see particular functions. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_set.rst b/docs/source/memcached_set.rst index 6776234c..a55ffff6 100644 --- a/docs/source/memcached_set.rst +++ b/docs/source/memcached_set.rst @@ -88,6 +88,7 @@ For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_ SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)` diff --git a/docs/source/memcached_stats.rst b/docs/source/memcached_stats.rst index d8f79533..e247a7be 100644 --- a/docs/source/memcached_stats.rst +++ b/docs/source/memcached_stats.rst @@ -72,6 +72,7 @@ memory allocated for it. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_strerror.rst b/docs/source/memcached_strerror.rst index 8d716876..115a58ff 100644 --- a/docs/source/memcached_strerror.rst +++ b/docs/source/memcached_strerror.rst @@ -42,6 +42,7 @@ RETURN SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/memcached_user_data.rst b/docs/source/memcached_user_data.rst index 3063caa3..b45f192e 100644 --- a/docs/source/memcached_user_data.rst +++ b/docs/source/memcached_user_data.rst @@ -59,6 +59,7 @@ RETURN SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/memcached_verbosity.rst b/docs/source/memcached_verbosity.rst index 3c73e316..6eedaf7e 100644 --- a/docs/source/memcached_verbosity.rst +++ b/docs/source/memcached_verbosity.rst @@ -42,6 +42,7 @@ Use :c:func:`memcached_strerror` to translate this value to a printable string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/source/memcached_version.rst b/docs/source/memcached_version.rst index fe261020..77f30b1d 100644 --- a/docs/source/memcached_version.rst +++ b/docs/source/memcached_version.rst @@ -50,6 +50,7 @@ a printable string. SEE ALSO -------- +.. only:: man -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/include/libhashkit-1.0/CMakeLists.txt b/include/libhashkit-1.0/CMakeLists.txt index bb97fb30..13e836f6 100644 --- a/include/libhashkit-1.0/CMakeLists.txt +++ b/include/libhashkit-1.0/CMakeLists.txt @@ -1,9 +1,7 @@ configure_file(configure.h.in configure.h @ONLY) -install_public_headers( - libhashkit-1.0 - +install_public_headers(libhashkit-1.0 algorithm.h basic_string.h behavior.h -- 2.30.2