From: Michael Wallner Date: Fri, 28 Feb 2020 15:38:16 +0000 (+0100) Subject: docs: sanitize X-Git-Tag: 1.1.0-beta1~250^2~7 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=43032f572a83233b5183ed6989921efe930aa719;p=awesomized%2Flibmemcached docs: sanitize --- diff --git a/docs/source/libmemcached/memcached_analyze.rst b/docs/source/libmemcached/memcached_analyze.rst index 9caeafa4..9cfda0d5 100644 --- a/docs/source/libmemcached/memcached_analyze.rst +++ b/docs/source/libmemcached/memcached_analyze.rst @@ -1,10 +1,8 @@ -================= Analyzing servers ================= Analyze server information --------- SYNOPSIS -------- @@ -19,7 +17,6 @@ SYNOPSIS .. function:: memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error) ------------ DESCRIPTION ----------- @@ -34,7 +31,6 @@ structure. The return value must be freed by the calling application. A command line tool, :program:`memstat` with the option :option:`memstat --analyze`, is provided so that you do not have to write an application to use this method. ------- RETURN ------ @@ -45,7 +41,6 @@ checking the :type:`memcached_return_t` value. Any method returning a :type:`memcached_analysis_st` expects you to free the memory allocated for it. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_append.rst b/docs/source/libmemcached/memcached_append.rst index ba3aaaab..5aa1ce3f 100644 --- a/docs/source/libmemcached/memcached_append.rst +++ b/docs/source/libmemcached/memcached_append.rst @@ -1,4 +1,3 @@ -============================================= Appending or Prepending to data on the server ============================================= @@ -6,7 +5,6 @@ Appending or Prepending to data on the server Appending or Prepending to data on the server --------- SYNOPSIS -------- @@ -22,7 +20,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -69,7 +66,6 @@ there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned. ------- RETURN ------ @@ -78,7 +74,6 @@ On success the value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_auto.rst b/docs/source/libmemcached/memcached_auto.rst index 03ed8bad..1171393d 100644 --- a/docs/source/libmemcached/memcached_auto.rst +++ b/docs/source/libmemcached/memcached_auto.rst @@ -1,10 +1,8 @@ -==================================== Incrementing and Decrementing Values ==================================== .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -28,7 +26,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -68,7 +65,6 @@ when using the binary protocol. :func:`memcached_increment_with_initial_by_key`, and :func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above. ------- RETURN ------ @@ -76,7 +72,6 @@ A value of type :type:`memcached_return_t` is returned. On success that value will be `MEMCACHED_SUCCESS`. Use memcached_strerror to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_cas.rst b/docs/source/libmemcached/memcached_cas.rst index aa8d5483..aec7ef46 100644 --- a/docs/source/libmemcached/memcached_cas.rst +++ b/docs/source/libmemcached/memcached_cas.rst @@ -1,10 +1,8 @@ -==================================================== Working with data on the server in an atomic fashion ==================================================== .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -16,7 +14,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -46,7 +43,6 @@ non-cas ASCII set operations, there are at least 1335 bytes available to split among the key, key_prefix, and value; for cas ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned. ------- RETURN ------ @@ -55,7 +51,6 @@ On success the value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_create.rst b/docs/source/libmemcached/memcached_create.rst index ab6760b1..1189fdf0 100644 --- a/docs/source/libmemcached/memcached_create.rst +++ b/docs/source/libmemcached/memcached_create.rst @@ -1,8 +1,6 @@ -====================================== Creating and destroying a memcached_st ====================================== --------- SYNOPSIS -------- @@ -20,7 +18,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -52,7 +49,6 @@ 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 heap allocated structures. ------- RETURN ------ @@ -62,7 +58,6 @@ that was created (or initialized). On an allocation failure, it returns NULL. :func:`memcached_clone` returns a pointer to the :type:`memcached_st` that was created (or initialized). On an allocation failure, it returns NULL. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_dump.rst b/docs/source/libmemcached/memcached_dump.rst index d8b5c9c5..e0c419f7 100644 --- a/docs/source/libmemcached/memcached_dump.rst +++ b/docs/source/libmemcached/memcached_dump.rst @@ -1,4 +1,3 @@ -========================== Dumping data from a server ========================== @@ -6,7 +5,6 @@ Get a list of keys found on memcached servers .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -18,7 +16,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -37,7 +34,6 @@ On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst index 7dc29e95..099eda2a 100644 --- a/docs/source/libmemcached/memcached_exist.rst +++ b/docs/source/libmemcached/memcached_exist.rst @@ -4,7 +4,6 @@ Determine if a keys exists. .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -18,13 +17,11 @@ Compile and link with -lmemcached .. versionadded:: 0.53 ------------ DESCRIPTION ----------- :func:`memcached_exist()` can be used to check if a key exists. ------- RETURN ------ @@ -34,7 +31,6 @@ RETURN `MEMCACHED_NOTFOUND` The key was not found. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst index a7f438a9..0e9378d9 100644 --- a/docs/source/libmemcached/memcached_fetch.rst +++ b/docs/source/libmemcached/memcached_fetch.rst @@ -1,10 +1,8 @@ -================= memcached_fetch ================= .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -17,7 +15,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -34,7 +31,6 @@ All of the above functions are not tested when the `MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :type:`memcached_return_t`, the error function parameter will be set to `MEMCACHED_NOT_SUPPORTED`. ------- RETURN ------ @@ -46,7 +42,6 @@ to `MEMCACHED_END` upon successful conclusion. and the key was set larger then `MEMCACHED_MAX_KEY`, which was the largest key allowed for the original memcached ascii server. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_flush.rst b/docs/source/libmemcached/memcached_flush.rst index 451e8e9f..071a989f 100644 --- a/docs/source/libmemcached/memcached_flush.rst +++ b/docs/source/libmemcached/memcached_flush.rst @@ -1,4 +1,3 @@ -===================================== Wiping clean the contents of a server ===================================== @@ -6,7 +5,6 @@ Wiping clean the contents of a server Wipe contents of memcached servers --------- SYNOPSIS -------- @@ -16,7 +14,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -34,7 +31,6 @@ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :type:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_flush_buffers.rst b/docs/source/libmemcached/memcached_flush_buffers.rst index d54da98a..45f9a9a7 100644 --- a/docs/source/libmemcached/memcached_flush_buffers.rst +++ b/docs/source/libmemcached/memcached_flush_buffers.rst @@ -1,4 +1,3 @@ -======================= Flushing client buffers ======================= @@ -6,7 +5,6 @@ Flushing client buffers Flush and send buffered commands --------- SYNOPSIS -------- @@ -16,14 +14,12 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- :func:`memcached_flush_buffers` is used in conjunction with `MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. ------- RETURN ------ @@ -32,7 +28,6 @@ On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_generate_hash_value.rst b/docs/source/libmemcached/memcached_generate_hash_value.rst index 9d8e00b3..9c84be7e 100644 --- a/docs/source/libmemcached/memcached_generate_hash_value.rst +++ b/docs/source/libmemcached/memcached_generate_hash_value.rst @@ -1,4 +1,3 @@ -=============================== Generating hash values directly =============================== @@ -41,7 +40,6 @@ SYNOPSIS Compile and link with -lmemcachedutil -lmemcached ------------ DESCRIPTION ----------- @@ -60,7 +58,6 @@ defaults of :type:`memcached_st`. As of version 0.36 all hash methods have been placed into the library libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. ------- RETURN ------ @@ -68,7 +65,6 @@ A 32-bit integer which is the result of hashing the given key. For 64-bit hash algorithms, only the least-significant 32 bits are returned. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_get.rst b/docs/source/libmemcached/memcached_get.rst index 0742b707..49b11ab3 100644 --- a/docs/source/libmemcached/memcached_get.rst +++ b/docs/source/libmemcached/memcached_get.rst @@ -1,10 +1,8 @@ -=============================== Retrieving data from the server =============================== .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -30,7 +28,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -109,7 +106,6 @@ keys at all were found. to `MEMCACHED_END` upon successful conclusion. `MEMCACHED_NOTFOUND` will be return if no keys at all were found. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_memory_allocators.rst b/docs/source/libmemcached/memcached_memory_allocators.rst index 7cd89122..f3fef087 100644 --- a/docs/source/libmemcached/memcached_memory_allocators.rst +++ b/docs/source/libmemcached/memcached_memory_allocators.rst @@ -1,4 +1,3 @@ -======================================== Use custom allocators for embedded usage ======================================== @@ -6,7 +5,6 @@ Use custom allocators for embedded usage Manage memory allocator functions --------- SYNOPSIS -------- @@ -28,7 +26,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -52,7 +49,6 @@ The first argument to the memory allocator functions is a pointer to a memcached structure, the is passed as const and you will need to clone it in order to make use of any operation which would modify it. ------ NOTES ----- @@ -60,7 +56,6 @@ In version 0.38 all functions were modified to have a context void pointer passed to them. This was so that customer allocators could have their own space for memory. ------- RETURN ------ @@ -68,7 +63,6 @@ RETURN upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set of function pointers. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_quit.rst b/docs/source/libmemcached/memcached_quit.rst index a50046d3..6559a7c4 100644 --- a/docs/source/libmemcached/memcached_quit.rst +++ b/docs/source/libmemcached/memcached_quit.rst @@ -1,10 +1,8 @@ -==================================== Disconnecting a client from a server ==================================== .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -14,7 +12,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -27,7 +24,6 @@ hashes and parameters will handle connections to the server for you. This function is provided mainly so that you can timeout your connections or reset connections during the middle of a :func:`memcached_fetch`. ------- RETURN ------ @@ -35,7 +31,6 @@ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_result_st.rst b/docs/source/libmemcached/memcached_result_st.rst index 76c80d02..67fd304f 100644 --- a/docs/source/libmemcached/memcached_result_st.rst +++ b/docs/source/libmemcached/memcached_result_st.rst @@ -1,8 +1,6 @@ -======================== Working with result sets ======================== --------- SYNOPSIS -------- @@ -36,7 +34,6 @@ SYNOPSIS Compile and link with -lmemcachedutil -lmemcached ------------ DESCRIPTION ----------- @@ -95,7 +92,6 @@ You may wish to avoid using memcached_result_create(3) with a stack based allocation. The most common issues related to ABI safety involve heap allocated structures. ------- RETURN ------ @@ -103,7 +99,6 @@ Varies, see particular functions. All structures must have :func:`memcached_result_free` called on them for cleanup purposes. Failure to do this will result in leaked memory. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_sasl.rst b/docs/source/libmemcached/memcached_sasl.rst index 26b00387..3be3f2b6 100644 --- a/docs/source/libmemcached/memcached_sasl.rst +++ b/docs/source/libmemcached/memcached_sasl.rst @@ -1,10 +1,8 @@ -============ SASL support ============ .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -20,7 +18,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -38,7 +35,6 @@ in memory. If you choose to use this method you have to call :type:`memcached_destroy_sasl_auth_data` if you specify your own callback function with :func:`memcached_set_sasl_callbacks`. ------- RETURN ------ @@ -46,7 +42,6 @@ RETURN this memcached handle. :func:`memcached_set_sasl_auth_data` returns `MEMCACHED_SUCCESS` upon success. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_servers.rst b/docs/source/libmemcached/memcached_servers.rst index a1286a7e..aef224a5 100644 --- a/docs/source/libmemcached/memcached_servers.rst +++ b/docs/source/libmemcached/memcached_servers.rst @@ -1,4 +1,3 @@ -======================================================== Manipulate the server information stored in memcached_st ======================================================== @@ -68,13 +67,11 @@ 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. :func:`memcached_server_cursor` is passed the original caller :type:`memcached_st` in its current state. ------- RETURN ------ Varies, see particular functions. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_set.rst b/docs/source/libmemcached/memcached_set.rst index e199427b..3daf5b6b 100644 --- a/docs/source/libmemcached/memcached_set.rst +++ b/docs/source/libmemcached/memcached_set.rst @@ -3,7 +3,6 @@ Storing data on the server .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -22,7 +21,6 @@ SYNOPSIS .. function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) ------------ DESCRIPTION ----------- diff --git a/docs/source/libmemcached/memcached_set_encoding_key.rst b/docs/source/libmemcached/memcached_set_encoding_key.rst index 467eb669..86721342 100644 --- a/docs/source/libmemcached/memcached_set_encoding_key.rst +++ b/docs/source/libmemcached/memcached_set_encoding_key.rst @@ -1,10 +1,8 @@ -================== Set encryption key ================== .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -14,7 +12,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -29,7 +26,6 @@ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_stats.rst b/docs/source/libmemcached/memcached_stats.rst index a6852982..92a0308c 100644 --- a/docs/source/libmemcached/memcached_stats.rst +++ b/docs/source/libmemcached/memcached_stats.rst @@ -1,4 +1,3 @@ -================================================== Working with statistical information from a server ================================================== @@ -6,7 +5,6 @@ Get memcached statistics .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -28,7 +26,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -52,7 +49,6 @@ obtain information on. A command line tool, memstat(1), is provided so that you do not have to write an application to do this. ------- RETURN ------ @@ -61,7 +57,6 @@ Varies, see particular functions. Any method returning a :type:`memcached_stat_st` expects you to free the memory allocated for it. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_touch.rst b/docs/source/libmemcached/memcached_touch.rst index 0e00264e..05c68790 100644 --- a/docs/source/libmemcached/memcached_touch.rst +++ b/docs/source/libmemcached/memcached_touch.rst @@ -4,7 +4,6 @@ memcached_touch, memcached_touch_by_key .. index:: object: memcached_st --------- SYNOPSIS -------- @@ -16,7 +15,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -24,7 +22,6 @@ DESCRIPTION :func:`memcached_touch_by_key` works the same, but it takes a master key to find the given value. ------- RETURN ------ @@ -33,7 +30,6 @@ On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_user_data.rst b/docs/source/libmemcached/memcached_user_data.rst index 06512244..c830a16b 100644 --- a/docs/source/libmemcached/memcached_user_data.rst +++ b/docs/source/libmemcached/memcached_user_data.rst @@ -6,13 +6,11 @@ Storing custom user information in the client. Manage user specific data -------- LIBRARY ------- C Client Library for memcached (libmemcached, -lmemcached) --------- SYNOPSIS -------- @@ -24,7 +22,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -36,7 +33,6 @@ the memcached_st structure. :func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure. ------- RETURN ------ @@ -44,7 +40,6 @@ RETURN :func:`memcached_get_user_data` returns the current value uf the user specific data. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_verbosity.rst b/docs/source/libmemcached/memcached_verbosity.rst index ed76a90d..db7aee16 100644 --- a/docs/source/libmemcached/memcached_verbosity.rst +++ b/docs/source/libmemcached/memcached_verbosity.rst @@ -1,4 +1,3 @@ -================================= Setting the verbosity of a server ================================= @@ -6,7 +5,6 @@ Setting the verbosity of a server Modify verbosity of servers --------- SYNOPSIS -------- @@ -16,14 +14,12 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- :func:`memcached_verbosity` modifies the "verbosity" of the memcached(1) servers referenced in the :type:`memcached_st` parameter. ------- RETURN ------ @@ -33,7 +29,6 @@ On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- diff --git a/docs/source/libmemcached/memcached_version.rst b/docs/source/libmemcached/memcached_version.rst index 40c41b70..6acb6c59 100644 --- a/docs/source/libmemcached/memcached_version.rst +++ b/docs/source/libmemcached/memcached_version.rst @@ -1,8 +1,6 @@ -======================================================= Getting version information about the client and server ======================================================= --------- SYNOPSIS -------- @@ -14,7 +12,6 @@ SYNOPSIS Compile and link with -lmemcached ------------ DESCRIPTION ----------- @@ -22,7 +19,6 @@ DESCRIPTION :func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code. ------- RETURN ------ @@ -38,7 +34,6 @@ If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value Use :func:`memcached_strerror` to translate this value to a printable string. --------- SEE ALSO --------