X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_value.rst;h=d27e35281ee74814941bd34f22ed469a5a98b986;hb=cfe08f8ecd0fd090430c417ac99999644041ba17;hp=e3f4f22cd5edfc45086b611ee743235429c13b8b;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst index e3f4f22c..d27e3528 100644 --- a/docs/hashkit_value.rst +++ b/docs/hashkit_value.rst @@ -3,39 +3,27 @@ hashkit_value ============= -Generate a value for the given key - - -------- -LIBRARY -------- - - -C Library for hashing algorithms (libhashkit, -lhashkit) +.. index:: object: hashkit_st +Generate a value for the given key -------- SYNOPSIS -------- +#include -.. code-block:: perl - - #include +.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length) - uint32_t hashkit_value(hashkit_st *hash, - const char *key, - size_t key_length); - - +Compile and link with -lhashkit ----------- DESCRIPTION ----------- -The hashkit_value() function generates a 32-bit hash value from the +The :c:func:`hashkit_value` function generates a 32-bit hash value from the given key and key_length. The hash argument is an initialized hashkit object, and distribution type and hash function is used from this object while generating the value. @@ -55,7 +43,7 @@ HOME To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -------- @@ -63,5 +51,5 @@ SEE ALSO -------- -hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3) +:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`