From f2a59b728c20f7fe78874dd41187ab3fb2db6c7e Mon Sep 17 00:00:00 2001
From: Brian Aker <brian@tangent.org>
Date: Sun, 16 Feb 2014 01:06:40 -0800
Subject: Fix for building docs.

---
 docs/source/memcached_flush.rst | 65 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/source/memcached_flush.rst

(limited to 'docs/source/memcached_flush.rst')

diff --git a/docs/source/memcached_flush.rst b/docs/source/memcached_flush.rst
new file mode 100644
index 00000000..042a4d42
--- /dev/null
+++ b/docs/source/memcached_flush.rst
@@ -0,0 +1,65 @@
+=====================================
+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.
+
+----
+HOME
+----
+
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-- 
cgit v1.2.1