Merge lp:~kent/libmemcached/KBDocs2 into lp:~tangent-org/libmemcached/trunk

[KentBozlinski]

Docs update, added memcached_return_t.rst. minor updates to several other files.

=== modified file 'docs/hashkit_create.rst'
--- docs/hashkit_create.rst	2011-05-24 01:36:22 +0000
+++ docs/hashkit_create.rst	2011-06-01 06:29:28 +0000
@@ -19,7 +19,18 @@
 .. c:function:: bool hashkit_is_allocated(const hashkit_st *hash);
 
 Compile and link with -lhashkit
-
+=======
+
+
+.. c:function:: perl
+
+.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash);
+ 
+.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+ 
+.. c:function:: void hashkit_free(hashkit_st *hash);
+ 
+.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash);
 
 -----------
 DESCRIPTION
 
=== modified file 'docs/libmemcached.rst'
--- docs/libmemcached.rst	2011-04-19 22:43:26 +0000
+++ docs/libmemcached.rst	2011-06-01 06:29:28 +0000
@@ -10,6 +10,8 @@
 
 Compile and link with -lmemcached
 
+=======
+
 libMemcached is an open source C/C++ client library and tools for the memcached server (http://danga.com/memcached). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
 
 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
 
=== added file 'docs/memcached_return_t.rst'
--- docs/memcached_return_t.rst	1970-01-01 00:00:00 +0000
+++ docs/memcached_return_t.rst	2011-06-01 06:29:28 +0000
@@ -0,0 +1,129 @@
+================================
+Error Codes (memcached_return_t)
+================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. c:type:: memcached_return_t
+
+.. c:function:: const char *libmemcached_strerror(libmemcached_return_t rc)
+
+.. c:function:: bool libmemcached_success(libmemcached_return_t rc)
+
+.. c:function:: bool libmemcached_failure(libmemcached_return_t rc)
+
+.. c:function:: bool libmemcache_continue(libmemcached_return_t rc)
+
+
+
+:c:func:`memcached_success()` return true if :c:type:`MEMCACHED_SUCCESS` tested true.
+
+:c:func:`memcached_failure()` return true if any value other then :c:type:`MEMCACHED_SUCCESS` was provided.
+
+
+
+
+.. c:type:: MEMCACHED_SUCCESS,
+
+.. c:type:: MEMCACHED_FAILURE,
+
+.. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE, // getaddrinfo() only
+
+.. c:type:: MEMCACHED_CONNECTION_FAILURE,  // DEPRECATED
+
+.. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE,  // DEPRECATED
+
+.. c:type:: MEMCACHED_WRITE_FAILURE,
+
+.. c:type:: MEMCACHED_READ_FAILURE,
+
+.. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE,
+
+.. c:type:: MEMCACHED_PROTOCOL_ERROR,
+
+.. c:type:: MEMCACHED_CLIENT_ERROR,
+
+.. c:type:: MEMCACHED_SERVER_ERROR,
+
+.. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE, // DEPRECATED
+
+.. c:type:: MEMCACHED_DATA_EXISTS,
+
+.. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST,
+
+.. c:type:: MEMCACHED_NOTSTORED,
+
+.. c:type:: MEMCACHED_STORED,
+
+.. c:type:: MEMCACHED_NOTFOUND,
+
+.. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE,
+
+.. c:type:: MEMCACHED_PARTIAL_READ,
+
+.. c:type:: MEMCACHED_SOME_ERRORS,
+
+.. c:type:: MEMCACHED_NO_SERVERS,
+
+.. c:type:: MEMCACHED_END,
+
+.. c:type:: MEMCACHED_DELETED,
+
+.. c:type:: MEMCACHED_VALUE,
+
+.. c:type:: MEMCACHED_STAT,
+
+.. c:type:: MEMCACHED_ITEM,
+
+.. c:type:: MEMCACHED_ERRNO,
+
+.. c:type:: MEMCACHED_FAIL_UNIX_SOCKET, // DEPRECATED
+
+.. c:type:: MEMCACHED_NOT_SUPPORTED,
+
+.. c:type:: MEMCACHED_NO_KEY_PROVIDED, /* Deprecated. Use MEMCACHED_BAD_KEY_PROVIDED! */
+
+.. c:type:: MEMCACHED_FETCH_NOTFINISHED,
+
+.. c:type:: MEMCACHED_TIMEOUT,
+
+.. c:type:: MEMCACHED_BUFFERED,
+
+.. c:type:: MEMCACHED_BAD_KEY_PROVIDED,
+
+.. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL,
+
+.. c:type:: MEMCACHED_SERVER_MARKED_DEAD,
+
+.. c:type:: MEMCACHED_UNKNOWN_STAT_KEY,
+
+.. c:type:: MEMCACHED_E2BIG,
+
+.. c:type:: MEMCACHED_INVALID_ARGUMENTS,
+
+.. c:type:: MEMCACHED_KEY_TOO_BIG,
+
+.. c:type:: MEMCACHED_AUTH_PROBLEM,
+
+.. c:type:: MEMCACHED_AUTH_FAILURE,
+
+.. c:type:: MEMCACHED_AUTH_CONTINUE,
+
+.. c:type:: MEMCACHED_PARSE_ERROR,
+
+.. c:type:: MEMCACHED_PARSE_USER_ERROR,
+
+.. c:type:: MEMCACHED_DEPRECATED,
+
+.. c:type:: MEMCACHED_MAXIMUM_RETURN /* Always add new error code before */
+   
+--------
+SEE ALSO
+--------
+
+:manpage:`memcached(8)` :manpage:`libmemcached(3)` :manpage:`memcached_client_error()` or :manpage:`memcached_worker_error()`
+
 
=== modified file 'docs/memcached_set.rst'
--- docs/memcached_set.rst	2011-05-24 01:36:22 +0000
+++ docs/memcached_set.rst	2011-06-01 06:29:28 +0000
@@ -34,10 +34,10 @@
 
 memcached_set(), memcached_add(), and memcached_replace() are all used to
 store information on the server. All methods take a key, and its length to
-store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol.
-You must supply both a value and a length. Optionally you
-may test an expiration time for the object and a 16 byte value (it is
-meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
+store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+store the object. Keys are currently limited to 250 characters by the
+memcached(1) server. You must supply both a value and a length. Optionally you
+may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
 
 memcached_set() will write an object to the server. If an object already
 exists it will overwrite what is in the server. If the object does not exist