X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_flush.rst;h=042a4d424fe4cf31d87d033301d3060623512cbc;hb=81204a653b40f87ae9f43fd8ee12cc8177021f3a;hp=fe251b4a0af5352c196a099ad684714cd0093bd6;hpb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;p=awesomized%2Flibmemcached diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst index fe251b4a..042a4d42 100644 --- a/docs/memcached_flush.rst +++ b/docs/memcached_flush.rst @@ -14,7 +14,7 @@ SYNOPSIS #include -.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration); +.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration) Compile and link with -lmemcached @@ -24,8 +24,8 @@ DESCRIPTION ----------- -:c:func:`memcached_flush()` is used to wipe clean the contents of memcached(1) -servers. It will either do this immediately or expire the content based on the +: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 @@ -39,9 +39,7 @@ RETURN A value of type :c:type:`memcached_return_t` is returned On success that value will be :c:type:`MEMCACHED_SUCCESS`. -Use :c:func:`memcached_strerror()` to translate this value to a printable -string. - +Use :c:type:`memcached_strerror` to translate this value to a printable string. ---- HOME