Merge in update such that trunk tree no longer commits manpages.
[m6w6/libmemcached] / docs / memcached_delete.rst
index 1c8acaf9beff1e8177f9a465a834a0562d8fce28..5c373b0847b7a0e9d68cc579faf808595e1acc44 100644 (file)
@@ -2,33 +2,20 @@
 Deleting data from a server
 ===========================
 
-
-Delete a key
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
+.. index:: object: memcached_st
 
 --------
 SYNOPSIS
 --------
 
 
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
-   memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+#include <libmemcached/memcached.h>
  
-   memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration);
+.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
 
+.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
 
+Compile and link with -lmemcached
 
 -----------
 DESCRIPTION
@@ -40,8 +27,8 @@ memcached_delete_by_key() works the same, but it takes a master key to
 find the given value.
 
 Expiration works by placing the item into a delete queue, which means that
-it won't possible to retrieve it by the "get" command, but "add" and 
-"replace" command with this key will also fail (the "set" command will 
+it won't be possible to retrieve it by the "get" command. The "add" and 
+"replace" commands with this key will also fail (the "set" command will 
 succeed, however). After the time passes, the item is finally deleted from server memory.
 
 Please note the the Danga memcached server removed tests for expiration in
@@ -67,7 +54,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 ------