Merge, better error messages

[m6w6/libmemcached] / docs / hashkit_functions.rst

diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst
index 542fd95f6021a93a27cbc4e9d5127b95fcaabef9..4db416614ca4536eb7537126051da6251e792f66 100644 (file)
--- a/docs/hashkit_functions.rst
+++ b/docs/hashkit_functions.rst
@@ -2,39 +2,38 @@
 Available Hashes
 ================
 
+.. index:: object: hashkit_st
 
 Various hash functions to use for calculating values for keys
 
 
--------
-LIBRARY
--------
+--------
+SYNOPSIS
+--------
 
+#include <libhashkit/hashkit.h>
+ 
+.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
 
-C Library for hashing algorithms (libmemcached, -lhashkit)
+.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
 
---------
-SYNOPSIS
---------
+.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
 
-.. code-block:: perl
+.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
 
-   #include <libmemcached/hashkit.h>
- 
-   uint32_t hashkit_default(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
-   uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
-   uint32_t hashkit_crc32(const char *key, size_t key_length);
-   uint32_t hashkit_hsieh(const char *key, size_t key_length);
-   uint32_t hashkit_murmur(const char *key, size_t key_length);
-   uint32_t hashkit_jenkins(const char *key, size_t key_length);
-   uint32_t hashkit_md5(const char *key, size_t key_length);
+.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
+
+.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
 
+Compile and link with -lhashkit
 
 
 -----------
@@ -46,7 +45,7 @@ These functions generate hash values from a key using a variety of
 algorithms. These functions can be used standalone, or as arguments
 to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
 
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
 the appropriate flag enabled.
 
 
@@ -64,7 +63,7 @@ HOME
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------
@@ -72,6 +71,5 @@ SEE ALSO
 --------
 
 
-hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
-hashkit_set_continuum_hash_fn(3)
+:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`