Merge in fix for url to main libmemcached.org site.

[awesomized/libmemcached] / docs / memcached_set.rst

diff --git a/docs/memcached_set.rst b/docs/memcached_set.rst
index 099d1559f70f2f013fd240617aea6211696bd71c..c2f08b3c4f527f19cf1eb23ed9c524266a768a89 100644 (file)
--- a/docs/memcached_set.rst
+++ b/docs/memcached_set.rst
@@ -6,115 +6,39 @@ Storing and Replacing Data
 Store value on server
 
 
--------
-LIBRARY
--------
+--------
+SYNOPSIS
+--------
 
 
-C Client Library for memcached (libmemcached, -lmemcached)
 
+#include <libmemcached/memcached.h>
+ 
+.. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
 
---------
-SYNOPSIS
---------
+.. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
 
+.. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
 
+.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
 
-.. code-block:: perl
+.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
 
-   #include <libmemcached/memcached.h>
- 
-   memcached_return_t
-     memcached_set (memcached_st *ptr,
-                    const char *key, size_t key_length, 
-                    const char *value, size_t value_length, 
-                    time_t expiration,
-                    uint32_t flags);
- 
-   memcached_return_t
-     memcached_add (memcached_st *ptr,
-                    const char *key, size_t key_length,
-                    const char *value, size_t value_length, 
-                    time_t expiration,
-                    uint32_t flags);
- 
-   memcached_return_t
-     memcached_replace (memcached_st *ptr,
-                        const char *key, size_t key_length,
-                        const char *value, size_t value_length, 
-                        time_t expiration,
-                        uint32_t flags);
- 
-   memcached_return_t 
-     memcached_prepend(memcached_st *ptr, 
-                       const char *key, size_t key_length,
-                       const char *value, size_t value_length, 
-                       time_t expiration,
-                       uint32_t flags)
- 
-   memcached_return_t 
-     memcached_append(memcached_st *ptr, 
-                      const char *key, size_t key_length,
-                       const char *value, size_t value_length, 
-                       time_t expiration,
-                       uint32_t flags)
-   memcached_return_t 
-     memcached_cas(memcached_st *ptr, 
-                   const char *key, size_t key_length,
-                   const char *value, size_t value_length, 
-                   time_t expiration,
-                   uint32_t flags,
-                   uint64_t cas);
- 
-   memcached_return_t 
-     memcached_set_by_key(memcached_st *ptr, 
-                          const char *master_key, size_t master_key_length, 
-                          const char *key, size_t key_length, 
-                          const char *value, size_t value_length, 
-                          time_t expiration,
-                          uint32_t flags);
- 
-   memcached_return_t 
-     memcached_add_by_key(memcached_st *ptr, 
-                          const char *master_key, size_t master_key_length,
-                          const char *key, size_t key_length,
-                          const char *value, size_t value_length, 
-                          time_t expiration,
-                          uint32_t flags);
- 
-   memcached_return_t 
-     memcached_replace_by_key(memcached_st *ptr, 
-                              const char *master_key, size_t master_key_length,
-                              const char *key, size_t key_length,
-                              const char *value, size_t value_length, 
-                              time_t expiration,
-                              uint32_t flags);
- 
-   memcached_return_t 
-     memcached_prepend_by_key(memcached_st *ptr, 
-                              const char *master_key, size_t master_key_length,
-                              const char *key, size_t key_length,
-                              const char *value, size_t value_length, 
-                              time_t expiration,
-                              uint32_t flags);
- 
-   memcached_return_t 
-     memcached_append_by_key(memcached_st *ptr, 
-                             const char *master_key, size_t master_key_length,
-                             const char *key, size_t key_length,
-                             const char *value, size_t value_length, 
-                             time_t expiration,
-                             uint32_t flags);
- 
-   memcached_return_t 
-     memcached_cas_by_key(memcached_st *ptr, 
-                          const char *master_key, size_t master_key_length,
-                          const char *key, size_t key_length,
-                          const char *value, size_t value_length, 
-                          time_t expiration,
-                          uint32_t flags,
-                          uint64_t cas);
+.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+
+.. c:function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+
+.. c:function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+
+.. c:function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+
+.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+
+.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+
+.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
 
+Compile and link with -lmemcached
 
 
 -----------
@@ -156,7 +80,7 @@ information on how to do this.
 memcached_set_by_key(), memcached_add_by_key(), memcached_replace_by_key(), 
 memcached_prepend_by_key(), memcached_append_by_key_by_key(), 
 memcached_cas_by_key() methods all behave in a similar method as the non key 
-methods. The difference is that they use their master_key parameter to map
+methods. The difference is that they use their group_key parameter to map
 objects to particular servers.
 
 If you are looking for performance, memcached_set() with non-blocking IO is 
@@ -199,7 +123,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------