From: Brian Aker <brian@tangent.org>
Date: Fri, 9 Sep 2011 07:29:39 +0000 (-0700)
Subject: Added rst.
X-Git-Tag: 0.52~4
X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=3b03232fa3a3344f8490ff0ca46cf14701b5a412;p=m6w6%2Flibmemcached

Added rst.
---

diff --git a/docs/conf.py.in b/docs/conf.py.in
index c27cd5c2..4f5a4c27 100644
--- a/docs/conf.py.in
+++ b/docs/conf.py.in
@@ -273,10 +273,12 @@ man_pages = [
   ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3),
   ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3),
+  ('libmemcached/memcached_last_error_message', 'memcached_last_error_message', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3),
@@ -300,7 +302,6 @@ man_pages = [
   ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3),
   ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3),
   ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3),
-  ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3),
   ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3),
diff --git a/docs/include.am b/docs/include.am
index d8c036d7..346bfe7c 100644
--- a/docs/include.am
+++ b/docs/include.am
@@ -101,6 +101,7 @@ man_MANS+= \
 	   docs/man/memcached_server_push.3 \
 	   docs/man/memcached_servers_parse.3 \
 	   docs/man/memcached_set.3 \
+	   docs/man/memcached_last_error_message.3 \
 	   docs/man/memcached_set_by_key.3 \
 	   docs/man/memcached_set_memory_allocators.3 \
 	   docs/man/memcached_set_sasl_callbacks.3 \
diff --git a/docs/index.rst b/docs/index.rst
index 57e2671d..64124709 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,8 +19,7 @@ Basics
    memcached_create
    libmemcached_examples
    libmemcached_configuration
-   error_messages
-
+   libmemcached/memcached_last_error_message
 
 #################
 Working with data
@@ -58,6 +57,7 @@ Advanced Topics
    memcached_server_st
    memcached_servers
    memcached_strerror
+   error_messages
    memcached_user_data
    memcached_verbosity
    memcached_version
diff --git a/docs/libmemcached/memcached_last_error_message.rst b/docs/libmemcached/memcached_last_error_message.rst
new file mode 100644
index 00000000..2a18d598
--- /dev/null
+++ b/docs/libmemcached/memcached_last_error_message.rst
@@ -0,0 +1,47 @@
+=================
+Retrieving errors
+=================
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+ 
+.. c:function::  const char *memcached_last_error_message(memcached_st *);
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:c:func:`memcached_last_error_message()` is used to return the last error
+message that the server responded too. If this error came from a specific
+server, its hostname and port will be provided in the error message.
+
+------
+RETURN
+------
+
+memcached_last_error_message() returns a const char* which does not need to be
+de-allocated. If no error has occurred then it will return NULL.
+
+----
+HOME
+----
+
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
+
+
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
+