projects / m6w6 / libmemcached / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree | github
raw | inline | side by side
Merge in additional documentation.
[m6w6/libmemcached] / docs / memcached_result_st.rst
diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst
index c33852d21f50d7163b2b486ed49fe22d01f66971..e8aba51842a009d50d6c2b982c13036806e59223 100644 (file)
--- a/docs/memcached_result_st.rst
+++ b/docs/memcached_result_st.rst
@@ -1,34 +1,28 @@
-.. highlight:: perl
+========================
+Working with result sets
+========================
 
 
 
 
-****
-NAME
-****
+Work with memcached_result_st
 
 
 
 
-memcached_result_create, memcached_result_free,
-memcached_result_key_value, memcached_result_key_length,
-memcached_result_value, memcached_result_length,
-memcached_result_flags, memcached_result_cas - Work with memcached_result_st
-
-
-*******
+-------
 LIBRARY
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
 
 
 
 .. code-block:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
    memcached_result_st *
      memcached_result_create (memcached_st *ptr,
  
    memcached_result_st *
      memcached_result_create (memcached_st *ptr,
@@ -58,16 +52,16 @@ SYNOPSIS
 
 
 
 
 
 
-***********
+-----------
 DESCRIPTION
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) can optionally return a memcached_result_st which acts as a
 result object. The result objects have added benefits over the character
 
 
 libmemcached(3) can optionally return a memcached_result_st which acts as a
 result object. The result objects have added benefits over the character
-pointer returns in that they are forward compatible with new return items
+pointer returns, in that they are forward compatible with new return items
 that future memcached servers may implement (the best current example of
 that future memcached servers may implement (the best current example of
-this is the CAS return item). The structures can also be reused which will
+this is the CAS return item). The structures can also be reused, which will
 save on calls to malloc(3). It is suggested that you use result objects over
 char \* return functions.
 
 save on calls to malloc(3). It is suggested that you use result objects over
 char \* return functions.
 
@@ -78,7 +72,7 @@ memcached_result_create() will either allocate memory for a
 memcached_result_st or will initialize a structure passed to it.
 
 memcached_result_free() will deallocate any memory attached to the
 memcached_result_st or will initialize a structure passed to it.
 
 memcached_result_free() will deallocate any memory attached to the
-structure. If the structure was also alloacted, it will deallocate it.
+structure. If the structure was also allocated, it will deallocate it.
 
 memcached_result_key_value() returns the key value associated with the
 current result object.
 
 memcached_result_key_value() returns the key value associated with the
 current result object.
@@ -97,7 +91,7 @@ current result object.
 
 memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
 
 memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
-supports it.
+tests it.
 
 memcached_result_set_value() takes a byte array and a size and sets
 the result to this value. This function is used for trigger responses.
 
 memcached_result_set_value() takes a byte array and a size and sets
 the result to this value. This function is used for trigger responses.
@@ -114,9 +108,9 @@ stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
 
 heap allocated structures.
 
 
-******
+------
 RETURN
 RETURN
-******
+------
 
 
 Varies, see particular functions. All structures must have
 
 
 Varies, see particular functions. All structures must have
@@ -124,27 +118,17 @@ memcached_result_free() called on them for cleanup purposes. Failure to
 do this will result in leaked memory.
 
 
 do this will result in leaked memory.
 
 
-****
+----
 HOME
 HOME
-****
+----
 
 
 To find out more information please check:
 
 
 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
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
Resurrection of libmemcached https://launchpad.net/libmemcached