From bf12e933c3c73aa04d8de2221144cc73cc9ef3b8 Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Fri, 8 Apr 2011 15:12:11 -0700 Subject: [PATCH] Updates for documentation style/etc. --- docs/hashkit_create.rst | 37 ++++++----------- docs/hashkit_functions.rst | 40 +++++++----------- docs/hashkit_value.rst | 38 +++++++---------- docs/index.rst | 26 +++++++----- docs/libmemcached.rst | 57 ++++++++++++-------------- docs/libmemcached_examples.rst | 43 ++++++++----------- docs/libmemcachedutil.rst | 44 ++++++++------------ docs/memcached_analyze.rst | 40 +++++++----------- docs/memcached_auto.rst | 3 +- docs/memcached_behavior.rst | 3 +- docs/memcached_callback.rst | 3 +- docs/memcached_create.rst | 3 +- docs/memcached_delete.rst | 4 +- docs/memcached_dump.rst | 3 +- docs/memcached_flush.rst | 4 +- docs/memcached_flush_buffers.rst | 3 +- docs/memcached_generate_hash_value.rst | 3 +- docs/memcached_get.rst | 4 +- docs/memcached_memory_allocators.rst | 4 +- docs/memcached_pool.rst | 4 +- docs/memcached_quit.rst | 4 +- docs/memcached_result_st.rst | 4 +- docs/memcached_sasl.rst | 3 +- docs/memcached_server_st.rst | 11 ++--- docs/memcached_servers.rst | 3 +- docs/memcached_set.rst | 40 +++++++----------- docs/memcached_stats.rst | 8 ++-- docs/memcached_strerror.rst | 11 ++--- docs/memcached_user_data.rst | 8 ++-- docs/memcached_verbosity.rst | 8 ++-- docs/memcached_version.rst | 8 ++-- docs/memcapable.rst | 8 ++-- docs/memcat.rst | 6 +-- docs/memcp.rst | 6 +-- docs/memdump.rst | 6 +-- docs/memerror.rst | 6 +-- docs/memflush.rst | 6 +-- docs/memrm.rst | 6 +-- docs/memslap.rst | 6 +-- docs/memstat.rst | 16 +------- 40 files changed, 204 insertions(+), 336 deletions(-) diff --git a/docs/hashkit_create.rst b/docs/hashkit_create.rst index 6679f88e..91687e0e 100644 --- a/docs/hashkit_create.rst +++ b/docs/hashkit_create.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - -hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated -***************************************************************** +============================ +Creating a hashkit structure +============================ Create and destroy hashkit objects -******* +------- LIBRARY -******* +------- C Library for hashing algorithms (libhashkit, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- @@ -36,9 +34,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- The hashkit_create() function initializes a hashkit object for use. If @@ -57,9 +55,9 @@ The hashkit_is_allocated() reports where the memory was allocated for a hashkit object. -************ +------------ RETURN VALUE -************ +------------ hashkit_create() and hashkit_clone() will return NULL on failure or @@ -70,19 +68,10 @@ object was allocated inside of hashkit_create() or hashkit_clone(), otherwise it is false and was user-supplied memory. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, - diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst index a0368839..12a1048e 100644 --- a/docs/hashkit_functions.rst +++ b/docs/hashkit_functions.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - -hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32, hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur, hashkit_jenkins, hashkit_md5 -***************************************************************************************************************************************************************** +================ +Available Hashes +================ Various hash functions to use for calculating values for keys -******* +------- LIBRARY -******* +------- C Library for hashing algorithms (libhashkit, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- @@ -39,9 +37,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- These functions generate hash values from a key using a variety of @@ -52,34 +50,26 @@ The hashkit_hsieh() is only available if the library is built with the appropriate flag enabled. -************ +------------ RETURN VALUE -************ +------------ A 32-bit hash value. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3) diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst index ec5d71b6..e3f4f22c 100644 --- a/docs/hashkit_value.rst +++ b/docs/hashkit_value.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - +============= hashkit_value -************* +============= Generate a value for the given key -******* +------- LIBRARY -******* +------- C Library for hashing algorithms (libhashkit, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- @@ -32,9 +30,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- The hashkit_value() function generates a 32-bit hash value from the @@ -43,34 +41,26 @@ object, and distribution type and hash function is used from this object while generating the value. -************ +------------ RETURN VALUE -************ +------------ A 32-bit hash value. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3) diff --git a/docs/index.rst b/docs/index.rst index 8db8ebbd..4b115cdf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,16 @@ -.. libmemcached documentation master file, created by - sphinx-quickstart on Sun Mar 6 12:05:53 2011. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - +======================================== Welcome to libmemcached's documentation! ======================================== -Contents: +------------ +Libmemcached +------------ .. toctree:: :maxdepth: 2 - hashkit_create - hashkit_functions - hashkit_value - libmemcached_examples libmemcached + libmemcached_examples libmemcachedutil memcached_analyze memcached_auto @@ -51,6 +46,17 @@ Contents: memslap memstat +---------- +Libhashkit +---------- + +.. toctree:: + :maxdepth: 2 + + hashkit_create + hashkit_functions + hashkit_value + Indices and tables ================== diff --git a/docs/libmemcached.rst b/docs/libmemcached.rst index 96fe94e7..76ad5740 100644 --- a/docs/libmemcached.rst +++ b/docs/libmemcached.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - +============ libmemcached -************ +============ Client library for memcached -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- @@ -28,9 +26,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- "Memcached is a high-performance, distributed memory object caching @@ -76,9 +74,9 @@ Some features of the library must be enabled through memcached_behavior_set(). Hope you enjoy it! -********* +--------- CONSTANTS -********* +--------- A number of constants have been provided for in the library. @@ -126,9 +124,9 @@ A number of constants have been provided for in the library. -********************* +--------------------- THREADS AND PROCESSES -********************* +--------------------- When using threads or forked processes it is important to keep an instance @@ -138,27 +136,26 @@ memcached_quit(3) on a \ ``memcached_st``\ and then use the resulting cloned structure. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached_examples(3) libmemcached(1) memcat(1) memcp(1) memflush(1) memrm(1) memslap(1) memstat(1) memcached_fetch(3) memcached_replace(3) memcached_server_list_free(3) libmemcached_examples(3) memcached_clone(3) memcached_free(3) memcached_server_add(3) memcached_server_push(3) memcached_add(3) memcached_get(3) memcached_server_count(3) memcached_servers_parse(3) memcached_create(3) memcached_increment(3) memcached_server_list(3) memcached_set(3) memcached_decrement(3) memcached_mget(3) memcached_server_list_append(3) memcached_strerror(3) memcached_delete(3) memcached_quit(3) memcached_server_list_count(3) memcached_verbosity(3) memcached_server_add_unix_socket(3) memcached_result_create(3) memcached_result_free(3) memcached_result_key_value(3) memcached_result_key_length(3) memcached_result_value(3) memcached_result_length(3) memcached_result_flags(3) memcached_result_cas(3) memcached_result_st(3) memcached_append(3) memcached_prepend(3) memcached_fetch_result(3) memerror(1) memcached_get_by_key(3) memcached_mget_by_key(3) memcached_delete_by_key(3) memcached_fetch_execute(3) memcached_callback_get(3) memcached_callback_set(3) memcached_version(3) memcached_lib_version(3) memcached_result_set_value(3) memcached_dump(3) memdump(1) memcached_set_memory_allocators(3) memcached_get_memory_allocators(3) memcached_get_user_data(3) memcached_set_user_data(3) - +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` :manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` :manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` :manpage:`memstat(1)` :manpage:`memcached_fetch(3)` :manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` :manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` :manpage:`memcached_free(3)` +:manpage:`memcached_server_add(3)` :manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` :manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` :manpage:`memcached_servers_parse(3)` :manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` :manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)` +:manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` :manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` :manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` :manpage:`memcached_server_add_unix_socket(3)` :manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)` +:manpage:`memcached_result_key_value(3)` :manpage:`memcached_result_key_length(3)` :manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)` :manpage:`memcached_result_flags(3)` +:manpage:`memcached_result_cas(3)` :manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)` +:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` :manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)` +:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` :manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)` +:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` :manpage:`memcached_dump(3)` :manpage:`memdump(1)` +:manpage:`memcached_set_memory_allocators(3)` :manpage:`memcached_get_memory_allocators(3)` :manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)` diff --git a/docs/libmemcached_examples.rst b/docs/libmemcached_examples.rst index 583d65a9..b6d27d5d 100644 --- a/docs/libmemcached_examples.rst +++ b/docs/libmemcached_examples.rst @@ -1,25 +1,23 @@ -.. highlight:: perl - - -libmemcached_examples -********************* +===================== +libmemcached examples +===================== Examples for libmemcached -*********** +----------- DESCRIPTION -*********** +----------- For full examples, test cases are found in tests/\*.c in the main distribution. These are always up to date, and are used for each test run of the library. +------------------------------ Creating and Freeing structure -============================== - +------------------------------ .. code-block:: perl @@ -36,8 +34,9 @@ The above code would create a connection and then free the connection when finished. +--------------------- Connecting to servers -===================== +--------------------- @@ -70,8 +69,9 @@ You can reuse the \ ``memcached_server_st``\ object with multile \ ``memcached_ structures. +---------------------------- Adding a value to the server -============================ +---------------------------- @@ -102,8 +102,9 @@ Adding a value to the server It is best practice to always look at the return value of any operation. +------------------------ Fetching multiple values -======================== +------------------------ @@ -136,27 +137,19 @@ Notice that you freed values returned from memcached_fetch(). The define -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- -memcached(1) +:manpage:`memcached(1)` diff --git a/docs/libmemcachedutil.rst b/docs/libmemcachedutil.rst index c9bf1b9f..046108da 100644 --- a/docs/libmemcachedutil.rst +++ b/docs/libmemcachedutil.rst @@ -1,25 +1,22 @@ -.. highlight:: perl - - +================ libmemcachedutil -**************** +================ -libmemcachedutil - Utility library for libmemcached +Utility library for libmemcached -******* +======= LIBRARY -******* +======= C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil) -******** +======== SYNOPSIS -******** - +======== .. code-block:: perl @@ -30,18 +27,18 @@ SYNOPSIS -*********** +=========== DESCRIPTION -*********** +=========== \ **libmemcachedutil**\ is a small and thread-safe client library that provides extra functionality built on top of \ **libmemcached**\ . -******* +======= THREADS -******* +======= Do not try to access an instance of \ ``memcached_st``\ from multiple threads @@ -50,27 +47,20 @@ you should either clone the \ ``memcached_st``\ , or use the memcached pool implementation. see memcached_pool_create(3). -**** +==== HOME -**** +==== To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Trond Norbye, - - -******** +======== SEE ALSO -******** +======== -libmemcached(3) memcached_pool_create(3) memcached_pool_destroy(3) memcached_pool_pop(3) memcached_pool_push(3) +:manpage:`libmemcached(3)` +:manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)` diff --git a/docs/memcached_analyze.rst b/docs/memcached_analyze.rst index da30e141..c177be92 100644 --- a/docs/memcached_analyze.rst +++ b/docs/memcached_analyze.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - +================= memcached_analyze -***************** +================= Analyze server information -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- @@ -33,9 +31,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- libmemcached(3) has the ability to query a memcached server (or collection @@ -50,9 +48,9 @@ A command line tool, memstat(1) with the option --analyze, is provided so that you do not have to write an application to use this method. -****** +------ RETURN -****** +------ A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and @@ -63,27 +61,19 @@ Any method returning a \ ``memcached_analysis_st``\ expects you to free the memory allocated for it. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Toru Maesaka, - - -******** +-------- SEE ALSO -******** +-------- -memcached(1) libmemcached(3) memcached_strerror(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_auto.rst b/docs/memcached_auto.rst index d92f1f88..31ff6178 100644 --- a/docs/memcached_auto.rst +++ b/docs/memcached_auto.rst @@ -167,5 +167,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_behavior.rst b/docs/memcached_behavior.rst index cc4cf687..96e3213d 100644 --- a/docs/memcached_behavior.rst +++ b/docs/memcached_behavior.rst @@ -401,5 +401,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_callback.rst b/docs/memcached_callback.rst index 43708b69..ac1760ab 100644 --- a/docs/memcached_callback.rst +++ b/docs/memcached_callback.rst @@ -169,5 +169,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst index 1beff43c..ace146cb 100644 --- a/docs/memcached_create.rst +++ b/docs/memcached_create.rst @@ -98,5 +98,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index dcec549f..440cf22c 100644 --- a/docs/memcached_delete.rst +++ b/docs/memcached_delete.rst @@ -91,6 +91,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst index 59bd7d54..1a28091a 100644 --- a/docs/memcached_dump.rst +++ b/docs/memcached_dump.rst @@ -84,5 +84,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_flush.rst b/docs/memcached_flush.rst index 41ca3696..95911809 100644 --- a/docs/memcached_flush.rst +++ b/docs/memcached_flush.rst @@ -76,6 +76,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst index e2067c15..2abb0e09 100644 --- a/docs/memcached_flush_buffers.rst +++ b/docs/memcached_flush_buffers.rst @@ -73,5 +73,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst index 0cefabb5..6eb7cf17 100644 --- a/docs/memcached_generate_hash_value.rst +++ b/docs/memcached_generate_hash_value.rst @@ -91,5 +91,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_get.rst b/docs/memcached_get.rst index 27ec765c..9c90dc68 100644 --- a/docs/memcached_get.rst +++ b/docs/memcached_get.rst @@ -205,6 +205,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst index 5de7fb67..540565ae 100644 --- a/docs/memcached_memory_allocators.rst +++ b/docs/memcached_memory_allocators.rst @@ -132,6 +132,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index ed5539eb..bef768df 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -129,6 +129,4 @@ Trond Norbye, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3) memcached_behavior_get(3) memcached_behavior_set(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_quit.rst b/docs/memcached_quit.rst index 974f4a50..99a91fb6 100644 --- a/docs/memcached_quit.rst +++ b/docs/memcached_quit.rst @@ -77,6 +77,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst index 7eba66da..c96c4605 100644 --- a/docs/memcached_result_st.rst +++ b/docs/memcached_result_st.rst @@ -141,6 +141,4 @@ Brian Aker, SEE ALSO ******** - -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 3e3b7789..155d64df 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -93,5 +93,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst index 67f4f3c1..9c7a9e31 100644 --- a/docs/memcached_server_st.rst +++ b/docs/memcached_server_st.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcached_server_list_free, memcached_server_list_append, memcached_server_list_count, memcached_servers_parse -************************************************************************************************************** +========================= +Managing lists of servers +========================= Manage server list @@ -113,5 +111,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst index d7aa521d..f2a6d259 100644 --- a/docs/memcached_servers.rst +++ b/docs/memcached_servers.rst @@ -148,5 +148,4 @@ SEE ALSO ******** -memcached(1) libmemcached(3) memcached_strerror(3) - +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` diff --git a/docs/memcached_set.rst b/docs/memcached_set.rst index d0dbbd26..9a5e58ad 100644 --- a/docs/memcached_set.rst +++ b/docs/memcached_set.rst @@ -1,24 +1,22 @@ -.. highlight:: perl - - -memcached_set, memcached_add, memcached_replace -*********************************************** +========================== +Storing and Replacing Data +========================== Store value on server -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- @@ -119,9 +117,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- memcached_set(), memcached_add(), and memcached_replace() are all used to @@ -182,9 +180,9 @@ total size of the command, including overhead, exceeds 1400 bytes, a \ ``MEMCACH will be returned. -****** +------ RETURN -****** +------ All methods return a value of type \ ``memcached_return_t``\ . @@ -195,26 +193,18 @@ For memcached_replace() and memcached_add(), \ ``MEMCACHED_NOTSTORED``\ is a legitmate error in the case of a collision. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- memcached(1) libmemached(3) memcached_strerror(3) diff --git a/docs/memcached_stats.rst b/docs/memcached_stats.rst index ee5103e7..4a5fbdb5 100644 --- a/docs/memcached_stats.rst +++ b/docs/memcached_stats.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys -******************************************************************************************** +================================================== +Working with statistical information from a server +================================================== Get memcached statistics diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst index 7848a59c..18e21c60 100644 --- a/docs/memcached_strerror.rst +++ b/docs/memcached_strerror.rst @@ -1,11 +1,6 @@ -.. highlight:: perl - - -memcached_strerror -****************** - - -Get error string +================================================ +Coverting Errors, memcached_return_t, to strings +================================================ ******* diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst index 1fd9d334..2032cbd3 100644 --- a/docs/memcached_user_data.rst +++ b/docs/memcached_user_data.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcached_set_user_data, memcached_get_user_data -************************************************ +============================================== +Storing custom user information in the client. +============================================== Manage user specific data diff --git a/docs/memcached_verbosity.rst b/docs/memcached_verbosity.rst index c0409244..0e751a02 100644 --- a/docs/memcached_verbosity.rst +++ b/docs/memcached_verbosity.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcached_verbosity -******************* +================================= +Setting the verbosity of a server +================================= Modifiy verbosity of servers diff --git a/docs/memcached_version.rst b/docs/memcached_version.rst index 334e09be..f00bef4e 100644 --- a/docs/memcached_version.rst +++ b/docs/memcached_version.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcached_lib_version, memcached_version -**************************************** +======================================================= +Getting version information about the client and server +======================================================= Get library version diff --git a/docs/memcapable.rst b/docs/memcapable.rst index b06d69a5..65dbd209 100644 --- a/docs/memcapable.rst +++ b/docs/memcapable.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - -memcapable -********** +============================================================ +Checking you Memcached server capibilities and compatibility +============================================================ Check memcached server capabilities diff --git a/docs/memcat.rst b/docs/memcat.rst index 35d68340..5203b144 100644 --- a/docs/memcat.rst +++ b/docs/memcat.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +====== memcat -****** +====== Copy a set of keys to stdout diff --git a/docs/memcp.rst b/docs/memcp.rst index 0a9146d8..222877be 100644 --- a/docs/memcp.rst +++ b/docs/memcp.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +===== memcp -***** +===== Copies files to a collection of memcached servers diff --git a/docs/memdump.rst b/docs/memdump.rst index 71531749..2580b693 100644 --- a/docs/memdump.rst +++ b/docs/memdump.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +======= memdump -******* +======= Dump a list of keys from a server. diff --git a/docs/memerror.rst b/docs/memerror.rst index 029f78dd..9c49ff9e 100644 --- a/docs/memerror.rst +++ b/docs/memerror.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +======== memerror -******** +======== Translate a memcached error code to a string diff --git a/docs/memflush.rst b/docs/memflush.rst index b0827853..e83f6b1f 100644 --- a/docs/memflush.rst +++ b/docs/memflush.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +======== memflush -******** +======== Reset a server or list of servers diff --git a/docs/memrm.rst b/docs/memrm.rst index 6d68572d..1b2c5314 100644 --- a/docs/memrm.rst +++ b/docs/memrm.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +===== memrm -***** +===== memrm - Remove a key(s) from a collection of memcached servers diff --git a/docs/memslap.rst b/docs/memslap.rst index 00d25178..0f180ea5 100644 --- a/docs/memslap.rst +++ b/docs/memslap.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +======= memslap -******* +======= memslap - Load testing and benchmarking tool for memcached diff --git a/docs/memstat.rst b/docs/memstat.rst index 99d46e8e..b22a47f9 100644 --- a/docs/memstat.rst +++ b/docs/memstat.rst @@ -1,8 +1,6 @@ -.. highlight:: perl - - +======= memstat -******* +======= memstat - Display the operating status of a single or group of memcached servers @@ -45,16 +43,6 @@ To find out more information please check: `http://launchpad.org/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - -Mark Atwood, - - ******** SEE ALSO ******** -- 2.30.2