From 61eeb2db5c1a53f02d1e423b3129c9951a8a604f Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Tue, 18 Oct 2011 14:08:56 -0700 Subject: [PATCH] Start updating docs. --- docs/conf.py.in | 2 + docs/include.am | 14 +++--- docs/index.rst | 9 ++++ docs/libmemcached-1.0/index.rst | 9 ++++ docs/libmemcached-1.0/memcached_touch.rst | 61 +++++++++++++++++++++++ docs/libmemcached-1.1/index.rst | 5 ++ 6 files changed, 94 insertions(+), 6 deletions(-) create mode 100644 docs/libmemcached-1.0/index.rst create mode 100644 docs/libmemcached-1.0/memcached_touch.rst create mode 100644 docs/libmemcached-1.1/index.rst diff --git a/docs/conf.py.in b/docs/conf.py.in index 5952dc2e..5686ad04 100644 --- a/docs/conf.py.in +++ b/docs/conf.py.in @@ -263,6 +263,8 @@ man_pages = [ ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', [u'Brian Aker'], 3), ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', [u'Brian Aker'], 3), ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), + ('libmemcached-1.0/memcached_touch', 'memcached_touch', u'libmemcached Documentation', [u'Brian Aker'], 3), + ('libmemcached-1.0/memcached_touch', 'memcached_touch_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), ('libmemcached/memcached_exist', 'memcached_exist', u'libmemcached Documentation', [u'Brian Aker'], 3), ('libmemcached/memcached_exist', 'memcached_exist_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3), diff --git a/docs/include.am b/docs/include.am index 51b9ed73..fd1cb592 100644 --- a/docs/include.am +++ b/docs/include.am @@ -54,19 +54,19 @@ man_MANS+= \ docs/man/memcached_decrement_with_initial.3 \ docs/man/memcached_delete.3 \ docs/man/memcached_delete_by_key.3 \ - docs/man/memcached_exist.3 \ - docs/man/memcached_exist_by_key.3 \ + docs/man/libmemcached_check_configuration.3 \ + docs/man/libmemcached_configuration.3 \ + docs/man/memcached.3 \ docs/man/memcached_destroy_sasl_auth_data.3 \ docs/man/memcached_dump.3 \ + docs/man/memcached_exist.3 \ + docs/man/memcached_exist_by_key.3 \ docs/man/memcached_fetch.3 \ docs/man/memcached_fetch_execute.3 \ docs/man/memcached_fetch_result.3 \ docs/man/memcached_flush_buffers.3 \ docs/man/memcached_free.3 \ docs/man/memcached_generate_hash.3 \ - docs/man/libmemcached_check_configuration.3 \ - docs/man/libmemcached_configuration.3 \ - docs/man/memcached.3 \ docs/man/memcached_generate_hash_value.3 \ docs/man/memcached_get.3 \ docs/man/memcached_get_by_key.3 \ @@ -95,6 +95,7 @@ man_MANS+= \ docs/man/memcached_quit.3 \ docs/man/memcached_replace.3 \ docs/man/memcached_replace_by_key.3 \ + docs/man/memcached_last_error_message.3 \ docs/man/memcached_sasl_set_auth_data.3 \ docs/man/memcached_server_add.3 \ docs/man/memcached_server_count.3 \ @@ -106,7 +107,6 @@ man_MANS+= \ docs/man/memcached_server_push.3 \ docs/man/memcached_servers_parse.3 \ docs/man/memcached_set.3 \ - docs/man/memcached_last_error_message.3 \ docs/man/memcached_set_by_key.3 \ docs/man/memcached_set_memory_allocators.3 \ docs/man/memcached_set_sasl_callbacks.3 \ @@ -117,6 +117,8 @@ man_MANS+= \ docs/man/memcached_stat_get_value.3 \ docs/man/memcached_stat_servername.3 \ docs/man/memcached_strerror.3 \ + docs/man/memcached_touch.3 \ + docs/man/memcached_touch_by_key.3 \ docs/man/memcached_verbosity.3 \ docs/man/memcached_version.3 \ docs/man/memcapable.1 \ diff --git a/docs/index.rst b/docs/index.rst index 1280cedc..286848e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,6 +64,15 @@ Advanced Topics memcached_verbosity memcached_version +################## +Interface Versions +################## + +.. toctree:: + :titlesonly: + + libmemcached-1.0/index + libmemcached-1.1/index #################### Deprecated Functions diff --git a/docs/libmemcached-1.0/index.rst b/docs/libmemcached-1.0/index.rst new file mode 100644 index 00000000..fb8ed307 --- /dev/null +++ b/docs/libmemcached-1.0/index.rst @@ -0,0 +1,9 @@ +==================== +libmemcached 1.0 API +==================== + + +.. toctree:: + :titlesonly: + + memcached_touch diff --git a/docs/libmemcached-1.0/memcached_touch.rst b/docs/libmemcached-1.0/memcached_touch.rst new file mode 100644 index 00000000..7390dd14 --- /dev/null +++ b/docs/libmemcached-1.0/memcached_touch.rst @@ -0,0 +1,61 @@ +=========================================== +memcached_touch(), memcached_touch_by_key() +=========================================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include + +.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); + +.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration); + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_touch()` is used to update the expiration time on an existing key. +:c:func:`memcached_touch_by_key()` works the same, but it takes a master key +to find the given value. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror()` to translate this value to a printable +string. + +---- +HOME +---- + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + diff --git a/docs/libmemcached-1.1/index.rst b/docs/libmemcached-1.1/index.rst new file mode 100644 index 00000000..01c1b31b --- /dev/null +++ b/docs/libmemcached-1.1/index.rst @@ -0,0 +1,5 @@ +==================== +libmemcached 1.1 API +==================== + +The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions. -- 2.30.2