Merge in update such that trunk tree no longer commits manpages.

[m6w6/libmemcached] / docs / memcached_delete.rst

diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst
index 56ad96977c6626c260d7a1e7ada1b16d888a832e..5c373b0847b7a0e9d68cc579faf808595e1acc44 100644 (file)
--- a/docs/memcached_delete.rst
+++ b/docs/memcached_delete.rst
@@ -1,43 +1,21 @@
-.. highlight:: perl
-
-
-memcached_delete
-----------------
-
-
-Delete a key
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
+===========================
+Deleting data from a server
+===========================
 
+.. 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
@@ -49,17 +27,17 @@ 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
 the 1.4 version.
 
 
-******
+------
 RETURN
-******
+------
 
 
 A value of type \ ``memcached_return_t``\  is returned
@@ -70,18 +48,18 @@ If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
+------
 AUTHOR
-******
+------
 
 
 Brian Aker, <brian@tangent.org>