docs: sanitize
authorMichael Wallner <mike@php.net>
Fri, 28 Feb 2020 15:38:16 +0000 (16:38 +0100)
committerMichael Wallner <mike@php.net>
Fri, 28 Feb 2020 15:38:16 +0000 (16:38 +0100)
24 files changed:
docs/source/libmemcached/memcached_analyze.rst
docs/source/libmemcached/memcached_append.rst
docs/source/libmemcached/memcached_auto.rst
docs/source/libmemcached/memcached_cas.rst
docs/source/libmemcached/memcached_create.rst
docs/source/libmemcached/memcached_dump.rst
docs/source/libmemcached/memcached_exist.rst
docs/source/libmemcached/memcached_fetch.rst
docs/source/libmemcached/memcached_flush.rst
docs/source/libmemcached/memcached_flush_buffers.rst
docs/source/libmemcached/memcached_generate_hash_value.rst
docs/source/libmemcached/memcached_get.rst
docs/source/libmemcached/memcached_memory_allocators.rst
docs/source/libmemcached/memcached_quit.rst
docs/source/libmemcached/memcached_result_st.rst
docs/source/libmemcached/memcached_sasl.rst
docs/source/libmemcached/memcached_servers.rst
docs/source/libmemcached/memcached_set.rst
docs/source/libmemcached/memcached_set_encoding_key.rst
docs/source/libmemcached/memcached_stats.rst
docs/source/libmemcached/memcached_touch.rst
docs/source/libmemcached/memcached_user_data.rst
docs/source/libmemcached/memcached_verbosity.rst
docs/source/libmemcached/memcached_version.rst

index 9caeafa4090e722d9b5d7a266be9bb3454aced03..9cfda0d5c67cecb20cbd533e59d346cc5c28cfeb 100644 (file)
@@ -1,10 +1,8 @@
-=================
 Analyzing servers
 =================
 
 Analyze server information
 
 Analyzing servers
 =================
 
 Analyze server information
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -19,7 +17,6 @@ SYNOPSIS
  
 .. function::  memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
 
  
 .. function::  memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 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
 ------
 
 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.
 
 Any method returning a :type:`memcached_analysis_st` expects you to free the
 memory allocated for it.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index ba3aaaab27426e503e48f979f324934a53fa64b7..5aa1ce3f482ac6c473ea308c8fecb820f60b8446 100644 (file)
@@ -1,4 +1,3 @@
-=============================================
 Appending or Prepending to data on the server
 =============================================
 
 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
 
 
 Appending or Prepending to data on the server
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -22,7 +20,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 and value. If the total size of the command, including overhead, exceeds 
 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
 
-------
 RETURN
 ------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 03ed8bad2ae0cc8ed91188665198f2c09f81a4ae..1171393d04f0260c8d6c8d2522550e18f407ec19 100644 (file)
@@ -1,10 +1,8 @@
-====================================
 Incrementing and Decrementing Values
 ====================================
 
 .. index:: object: memcached_st
 
 Incrementing and Decrementing Values
 ====================================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -28,7 +26,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 :func:`memcached_increment_with_initial_by_key`, and
 :func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
 
-------
 RETURN
 ------
 
 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.
 
 On success that value will be `MEMCACHED_SUCCESS`.
 Use memcached_strerror to translate this value to a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index aa8d5483932747d75e9dade82963a867792ed2cd..aec7ef46cbcafff779d301525c51559d691f1379 100644 (file)
@@ -1,10 +1,8 @@
-====================================================
 Working with data on the server in an atomic fashion
 ====================================================
 
 .. index:: object: memcached_st
 
 Working with data on the server in an atomic fashion
 ====================================================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -16,7 +14,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 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
 ------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index ab6760b148597cc4950b6a5357028e6286388a11..1189fdf07577d2eca6578e99038fdfabd7f41e56 100644 (file)
@@ -1,8 +1,6 @@
-======================================
 Creating and destroying a memcached_st
 ======================================
 
 Creating and destroying a memcached_st
 ======================================
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -20,7 +18,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
-------
 RETURN
 ------
 
 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.
 
 :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
 --------
 
 SEE ALSO
 --------
 
index d8b5c9c5b79ee1f8622041af4eb55c302d5d9f8a..e0c419f79df2904c1bc0e74b656c477f7a5580aa 100644 (file)
@@ -1,4 +1,3 @@
-==========================
 Dumping data from a server
 ==========================
 
 Dumping data from a server
 ==========================
 
@@ -6,7 +5,6 @@ Get a list of keys found on memcached servers
 
 .. index:: object: memcached_st
 
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -18,7 +16,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 7dc29e954894b99ea9e86bea99624d953e19c0d6..099eda2a85b1a8dfce4f4af94b8ca63cf55cbbef 100644 (file)
@@ -4,7 +4,6 @@ Determine if a keys exists.
 
 .. index:: object: memcached_st
 
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -18,13 +17,11 @@ Compile and link with -lmemcached
 
 .. versionadded:: 0.53
 
 
 .. versionadded:: 0.53
 
------------
 DESCRIPTION
 -----------
 
 :func:`memcached_exist()` can be used to check if a key exists.
 
 DESCRIPTION
 -----------
 
 :func:`memcached_exist()` can be used to check if a key exists.
 
-------
 RETURN
 ------
 
 RETURN
 ------
 
@@ -34,7 +31,6 @@ RETURN
 `MEMCACHED_NOTFOUND`
   The key was not found.
 
 `MEMCACHED_NOTFOUND`
   The key was not found.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index a7f438a92d0c1bc80b68d526c220bec9b1e04664..0e9378d9d9bc6f99856953f784cb7fe6a174f695 100644 (file)
@@ -1,10 +1,8 @@
-=================
 memcached_fetch
 =================
 
 .. index:: object: memcached_st
 
 memcached_fetch
 =================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -17,7 +15,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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`.
 
 `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
 ------
 
 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.
 
 and the key was set larger then `MEMCACHED_MAX_KEY`, which was the largest
 key allowed for the original memcached ascii server.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 451e8e9fe79ddbe6cd2b05b0911e079934c9a0fa..071a989ff1fe2608b50ddbdafb0179ac9d67f738 100644 (file)
@@ -1,4 +1,3 @@
-=====================================
 Wiping clean the contents of a server
 =====================================
 
 Wiping clean the contents of a server
 =====================================
 
@@ -6,7 +5,6 @@ Wiping clean the contents of a server
 
 Wipe contents of memcached servers
 
 
 Wipe contents of memcached servers
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -16,7 +14,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 On success that value will be `MEMCACHED_SUCCESS`.
 Use :type:`memcached_strerror` to translate this value to a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index d54da98a5d628d0b1129f460a13718a3935dc84d..45f9a9a729ab785e730669fc62b0e28a11dbf5f2 100644 (file)
@@ -1,4 +1,3 @@
-=======================
 Flushing client buffers
 =======================
 
 Flushing client buffers
 =======================
 
@@ -6,7 +5,6 @@ Flushing client buffers
 
 Flush and send buffered commands
 
 
 Flush and send buffered commands
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -16,14 +14,12 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 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.
 
 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
 ------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 9d8e00b311e18392fd14772d8cdf894cf8ecca16..9c84be7e0f4b286f3c7403ca076a6ea0051b1053 100644 (file)
@@ -1,4 +1,3 @@
-===============================
 Generating hash values directly
 ===============================
 
 Generating hash values directly
 ===============================
 
@@ -41,7 +40,6 @@ SYNOPSIS
 
 Compile and link with -lmemcachedutil -lmemcached
 
 
 Compile and link with -lmemcachedutil -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 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
 ------
 
 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.
 
 For 64-bit hash algorithms, only the least-significant 32 bits are
 returned.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 0742b7076d42eb7b4db0ea6e1403fbf336a833cd..49b11ab3663489c8a90811010f03224e8f622df0 100644 (file)
@@ -1,10 +1,8 @@
-===============================
 Retrieving data from the server
 ===============================
 
 .. index:: object: memcached_st
 
 Retrieving data from the server
 ===============================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -30,7 +28,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 to `MEMCACHED_END` upon successful conclusion.
 `MEMCACHED_NOTFOUND` will be return if no keys at all were found.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 7cd89122d9035e282ab083c3f348e92c62b1f79c..f3fef087da260a02179a6d82ef74441e958f98a8 100644 (file)
@@ -1,4 +1,3 @@
-========================================
 Use custom allocators for embedded usage
 ========================================
 
 Use custom allocators for embedded usage
 ========================================
 
@@ -6,7 +5,6 @@ Use custom allocators for embedded usage
 
 Manage memory allocator functions
 
 
 Manage memory allocator functions
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -28,7 +26,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 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
 -----
 
 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.
 
 passed to them. This was so that customer allocators could have their
 own space for memory.
 
-------
 RETURN
 ------
 
 RETURN
 ------
 
@@ -68,7 +63,6 @@ RETURN
 upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set 
 of function pointers.
 
 upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set 
 of function pointers.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index a50046d3d28959c63b8b2233f18b437cf7084678..6559a7c4a0020c4a74132003191e7c6169dccaa7 100644 (file)
@@ -1,10 +1,8 @@
-====================================
 Disconnecting a client from a server
 ====================================
 
 .. index:: object: memcached_st
 
 Disconnecting a client from a server
 ====================================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -14,7 +12,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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`.
 
 function is provided mainly so that you can timeout your connections or
 reset connections during the middle of a :func:`memcached_fetch`.
 
-------
 RETURN
 ------
 
 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.
 
 will be `MEMCACHED_SUCCESS`.  Use :func:`memcached_strerror` to
 translate this value to a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 76c80d02407e1a2ed992f301f639812b6618bc29..67fd304fcbf0710f23da9e953098acafaa38aef4 100644 (file)
@@ -1,8 +1,6 @@
-========================
 Working with result sets
 ========================
 
 Working with result sets
 ========================
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -36,7 +34,6 @@ SYNOPSIS
 
 Compile and link with -lmemcachedutil -lmemcached
 
 
 Compile and link with -lmemcachedutil -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
-------
 RETURN
 ------
 
 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.
 
 :func:`memcached_result_free` called on them for cleanup purposes. Failure 
 to do this will result in leaked memory.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 26b003877e4ab162800b1944c63238e2aa8f3a25..3be3f2b6f6b9b3413d1c820598a883c256a40eca 100644 (file)
@@ -1,10 +1,8 @@
-============
 SASL support
 ============
 
 .. index:: object: memcached_st
 
 SASL support
 ============
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -20,7 +18,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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`.
 
 :type:`memcached_destroy_sasl_auth_data` if you specify your own callback 
 function with :func:`memcached_set_sasl_callbacks`.
 
-------
 RETURN
 ------
 
 RETURN
 ------
 
@@ -46,7 +42,6 @@ RETURN
 this memcached handle. :func:`memcached_set_sasl_auth_data` returns
 `MEMCACHED_SUCCESS` upon success.
 
 this memcached handle. :func:`memcached_set_sasl_auth_data` returns
 `MEMCACHED_SUCCESS` upon success.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index a1286a7e95ae5555e746ca552535a53b62c64e80..aef224a50afd9e92b09aeef0797b88eac04c9a91 100644 (file)
@@ -1,4 +1,3 @@
-========================================================
 Manipulate the server information stored in memcached_st
 ========================================================
 
 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.
 
 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.
 
 RETURN
 ------
 
 Varies, see particular functions.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index e199427b255fa68f7c63d2e5de5a533f025757b9..3daf5b6b35a3eea339b94227f4ecb9ec4496b8ed 100644 (file)
@@ -3,7 +3,6 @@ Storing data on the server
 
 .. index:: object: memcached_st
 
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 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)
 
 
 .. 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
 -----------
 
 DESCRIPTION
 -----------
 
index 467eb6693232b99145022e677efdd44360f83d6f..867213422c0c812dade50f84077c8ae31ca34af7 100644 (file)
@@ -1,10 +1,8 @@
-==================
 Set encryption key
 ==================
 
 .. index:: object: memcached_st
 
 Set encryption key
 ==================
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -14,7 +12,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 will be `MEMCACHED_SUCCESS`.  Use :func:`memcached_strerror` to
 translate this value to a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index a68529826d4d90168c3cd64ba895b176d6a143bf..92a0308c0f6226c49a144a4019bb9471eb82da83 100644 (file)
@@ -1,4 +1,3 @@
-==================================================
 Working with statistical information from a server
 ==================================================
 
 Working with statistical information from a server
 ==================================================
 
@@ -6,7 +5,6 @@ Get memcached statistics
 
 .. index:: object: memcached_st
 
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -28,7 +26,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 A command line tool, memstat(1), is provided so that you do not have to write
 an application to do this.
 
-------
 RETURN
 ------
 
 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.
 
 Any method returning a :type:`memcached_stat_st` expects you to free the
 memory allocated for it.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 0e00264eb9317e28ed4579d4bc1706ff458b6a4e..05c68790b285b9f698e867cb84dd1311aef57353 100644 (file)
@@ -4,7 +4,6 @@ memcached_touch, memcached_touch_by_key
 
 .. index:: object: memcached_st
 
 
 .. index:: object: memcached_st
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -16,7 +15,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 :func:`memcached_touch_by_key` works the same, but it takes a master key 
 to find the given value.
 
-------
 RETURN
 ------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to a printable 
 string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 0651224421965a5e699e1d521c77f57f7a9e7d18..c830a16b84318a004c4ee9f8b5c7118d7ce81d1a 100644 (file)
@@ -6,13 +6,11 @@ Storing custom user information in the client.
 
 Manage user specific data
 
 
 Manage user specific data
 
--------
 LIBRARY
 -------
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 LIBRARY
 -------
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -24,7 +22,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 
 :func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure.
 
-------
 RETURN
 ------
 
 RETURN
 ------
 
@@ -44,7 +40,6 @@ RETURN
 
 :func:`memcached_get_user_data` returns the current value uf the user specific data.
 
 
 :func:`memcached_get_user_data` returns the current value uf the user specific data.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index ed76a90d741d10ce3010648ba841c73e89bd350f..db7aee16f23f574a80c5448deb2825d95bf33155 100644 (file)
@@ -1,4 +1,3 @@
-=================================
 Setting the verbosity of a server
 =================================
 
 Setting the verbosity of a server
 =================================
 
@@ -6,7 +5,6 @@ Setting the verbosity of a server
 
 Modify verbosity of servers
 
 
 Modify verbosity of servers
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -16,14 +14,12 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 :func:`memcached_verbosity` modifies the "verbosity" of the
 memcached(1) servers referenced in the :type:`memcached_st`  parameter.
 
 DESCRIPTION
 -----------
 
 :func:`memcached_verbosity` modifies the "verbosity" of the
 memcached(1) servers referenced in the :type:`memcached_st`  parameter.
 
-------
 RETURN
 ------
 
 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.
 
 
 Use :func:`memcached_strerror` to translate this value to a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------
 
index 40c41b70f734a10e4b2e7a996230ad50288c3e08..6acb6c590ddf6103146aa1ff4cdac4b0bd188b94 100644 (file)
@@ -1,8 +1,6 @@
-=======================================================
 Getting version information about the client and server
 =======================================================
 
 Getting version information about the client and server
 =======================================================
 
---------
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 
@@ -14,7 +12,6 @@ SYNOPSIS
 
 Compile and link with -lmemcached
 
 
 Compile and link with -lmemcached
 
------------
 DESCRIPTION
 -----------
 
 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.
 
 
 :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
 ------
 
 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.
 
 Use :func:`memcached_strerror` to translate this value to
 a printable string.
 
---------
 SEE ALSO
 --------
 
 SEE ALSO
 --------