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

[awesomized/libmemcached] / docs / memcached_strerror.rst

diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst
index 9ae638229f887bad10493163341bd156395fd979..ce5b1fa0b9bbbd7440b1c1ee76a2ed4c3fecc3a9 100644 (file)
--- a/docs/memcached_strerror.rst
+++ b/docs/memcached_strerror.rst
@@ -1,41 +1,24 @@
-.. highlight:: perl
+================================================
+Coverting Errors, memcached_return_t, to strings
+================================================
 
 
-****
-NAME
-****
+.. index:: object: memcached_st
 
-
-memcached_strerror - Get error string
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
 SYNOPSIS
-********
-
-
+--------
 
-.. code-block:: perl
+#include <libmemcached/memcached.h>
 
-   #include <memcached.h>
- 
-   const char *
-     memcached_strerror (memcached_st *ptr,
-                         memcached_return_t rc);
+.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
 
+Compile and link with -lmemcached
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_strerror() takes a \ ``memcached_return_t``\  value and returns a string
@@ -49,34 +32,27 @@ This string must not be modified by the application.
 with switch/case and know that you are capturing all possible return values.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_strerror() returns a string describing a \ ``memcached_return_t``\  value.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
-Brian Aker, <brian@tangent.org>
 
 
-********
+--------
 SEE ALSO
-********
+--------
 
 
 memcached(1) libmemcached(3)