docs: sanitize
[m6w6/libmemcached] / docs / source / libmemcached / memcached_dump.rst
index 077ca7e7c9b23be857e8def5857c973112439a5b..e0c419f79df2904c1bc0e74b656c477f7a5580aa 100644 (file)
@@ -1,54 +1,39 @@
-==========================
 Dumping data from a server
 ==========================
 
-
 Get a list of keys found on memcached servers
 
 .. index:: object: memcached_st
 
-
---------
 SYNOPSIS
 --------
 
-
 #include <libmemcached/memcached.h>
 
 .. function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
+
 .. type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context)
 
 Compile and link with -lmemcached
 
-
-
------------
 DESCRIPTION
 -----------
 
-
-:func:`memcached_dump` is used to get a list of keys found in memcached(1) 
+:func:`memcached_dump` is used to get a list of keys found in memcached(1)
 servers. Because memcached(1) does not guarantee to dump all keys you can not
 assume you have fetched all keys from the server. The function takes an array
 of callbacks that it will use to execute on keys as they are found.
 
 Currently the binary protocol is not tested.
 
-
-------
 RETURN
 ------
 
-
 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
 --------