docs: sanitize
[awesomized/libmemcached] / docs / source / memcached_flush.rst
diff --git a/docs/source/memcached_flush.rst b/docs/source/memcached_flush.rst
deleted file mode 100644 (file)
index 94612f4..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-=====================================
-Wiping clean the contents of a server
-=====================================
-
-.. index:: object: memcached_st
-
-Wipe contents of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
-It will either do this immediately or expire the content based on the
-expiration time passed to the method (a value of zero causes an immediate
-flush). The operation is not atomic to multiple servers, just atomic to a
-single server. That is, it will flush the servers in the order that they were
-added.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned 
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:type:`memcached_strerror` to translate this value to a printable string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`