Make sure we use the correct strerror() in case someone is using threads.

[awesomized/libmemcached] / docs / memcached_delete.rst

diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst
index 7c99276300dffd7a1007001fd228f385ad6c2fdb..5c373b0847b7a0e9d68cc579faf808595e1acc44 100644 (file)
--- a/docs/memcached_delete.rst
+++ b/docs/memcached_delete.rst
@@ -1,48 +1,25 @@
-.. highlight:: perl
+===========================
+Deleting data from a server
+===========================

 
 

+.. index:: object: memcached_st

 
 

-****
-NAME
-****
-
-
-memcached_delete - Delete a key
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------

 SYNOPSIS
 SYNOPSIS

-********
-
-
+--------

 
 

-.. code-block:: perl

 
 

-   #include <memcached.h>
+#include <libmemcached/memcached.h>

  
  

-   memcached_return_t
-     memcached_delete (memcached_st *ptr,
-                       const char *key, size_t key_length,
-                       time_t expiration);
- 
-   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
 DESCRIPTION

-***********
+-----------

 
 
 memcached_delete() is used to delete a particular key. 
 
 
 memcached_delete() is used to delete a particular key. 


@@ -50,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
 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.
 
 succeed, however). After the time passes, the item is finally deleted from server memory.
 

-Please note the the Danga memcached server removed support for expiration in
+Please note the the Danga memcached server removed tests for expiration in

 the 1.4 version.
 
 
 the 1.4 version.
 
 

-******
+------

 RETURN
 RETURN

-******
+------

 
 
 A value of type \ ``memcached_return_t``\  is returned
 
 
 A value of type \ ``memcached_return_t``\  is returned


@@ -71,27 +48,25 @@ If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.
 
 
 means that the message was queued for delivery.
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check:
 
 
 To find out more information please check:

-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_

 
 
 
 

-******
+------

 AUTHOR
 AUTHOR

-******
+------

 
 
 Brian Aker, <brian@tangent.org>
 
 
 
 
 Brian Aker, <brian@tangent.org>
 
 

-********
+--------

 SEE ALSO
 SEE ALSO

-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------

 
 

+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`