Merge working tree with build tree.

[m6w6/libmemcached] / docs / memcached_generate_hash_value.rst

diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst
index 0cefabb54ce65555378604da5b64e8f5683880f7..5b835df9e6a48c1d710351abf533e8e3e3951cfe 100644 (file)
--- a/docs/memcached_generate_hash_value.rst
+++ b/docs/memcached_generate_hash_value.rst
@@ -1,67 +1,73 @@
-.. highlight:: perl
+===============================
+Generating hash values directly
+===============================

 
 

+.. index:: object: memcached_st

 
 

-memcached_generate_hash_value
-*****************************
+Hash a key value

 
 
 
 

-Hash a key value
+-------- 
+SYNOPSIS 
+--------
+

 
 

+#include <libmemcached/memcached.h>

 
 

-*******
-LIBRARY
-*******
+.. c:type:: memcached_hash_t
+ 
+.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)

 
 

+.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)

 
 

-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:type:: MEMCACHED_HASH_DEFAULT

 
 

+.. c:type:: MEMCACHED_HASH_MD5

 
 

-********
-SYNOPSIS
-********
+.. c:type:: MEMCACHED_HASH_CRC

 
 

+.. c:type:: MEMCACHED_HASH_FNV1_64

 
 

+.. c:type:: MEMCACHED_HASH_FNV1A_64

 
 

-.. code-block:: perl
+.. c:type:: MEMCACHED_HASH_FNV1_32

 
 

-   #include <libmemcached/memcached.h>
- 
-   uint32_t
-     memcached_generate_hash_value (const char *key,
-                                    size_t key_length,
-                                    memcached_hash_t hash_algorithm);
- 
-   uint32_t 
-     memcached_generate_hash (memcached_st *ptr,
-                              const char *key, 
-                              size_t key_length);
+.. c:type:: MEMCACHED_HASH_FNV1A_32

 
 

+.. c:type:: MEMCACHED_HASH_JENKINS

 
 

+.. c:type:: MEMCACHED_HASH_MURMUR

 
 

-***********
+.. c:type:: MEMCACHED_HASH_HSIEH
+
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+-----------

 DESCRIPTION
 DESCRIPTION

-***********
+-----------

 
 
 
 

-memcached_generate_hash_value() allows you to hash a key using one of
+:c:func:`memcached_generate_hash_value` allows you to hash a key using one of

 the hash functions defined in the library. This method is provided for
 the convenience of higher-level language bindings and is not necessary
 for normal memcache operations.
 
 The allowed hash algorithm constants are listed in the manpage for
 the hash functions defined in the library. This method is provided for
 the convenience of higher-level language bindings and is not necessary
 for normal memcache operations.
 
 The allowed hash algorithm constants are listed in the manpage for

-memcached_behavior_set().
+:c:func:`memcached_behavior_set`.

 
 

-memcached_generate_hash() takes a memcached_st struture and produces
-the hash value that would have been generated based on the defaults
-of the memcached_st structure.
+:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` struture 
+and produces the hash value that would have been generated based on the 
+defaults of :c:type:`memcached_st`.

 
 As of version 0.36 all hash methods have been placed into the library
 
 As of version 0.36 all hash methods have been placed into the library

-libhashkit(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.

 
 
 
 

-******
+------

 RETURN
 RETURN

-******
+------

 
 
 A 32-bit integer which is the result of hashing the given key.
 
 
 A 32-bit integer which is the result of hashing the given key.


@@ -69,27 +75,26 @@ For 64-bit hash algorithms, only the least-significant 32 bits are
 returned.
 
 
 returned.
 
 

-****
+----

 HOME
 HOME

-****
+----

 
 
 To find out more information please check: 
 
 
 To find out more information please check: 

-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_

 
 
 
 

-******
+------

 AUTHOR
 AUTHOR

-******
+------

 
 
 Brian Aker, <brian@tangent.org>
 
 
 
 
 Brian Aker, <brian@tangent.org>
 
 

-********
+--------

 SEE ALSO
 SEE ALSO

-********
-
+--------

 
 

-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)

 
 

+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`