Start updating docs.

diff --git a/docs/conf.py.in b/docs/conf.py.in
index 5952dc2ea7e36b0e6253c4d44648f1b2e6514d98..5686ad04fbe1337cc95ad1c15ca9b50abb873374 100644 (file)
--- 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 51b9ed73d72f267bf34648209e45a127060f334f..fd1cb592d547fd00945f4f5907863f94056232c8 100644 (file)
--- 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 1280cedcfb180815f7c65bca4a6e2fe69a3baaa3..286848e59747f8925733cdbfedc231fae1a456bf 100644 (file)
--- 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 (file)
index 0000000..fb8ed30
--- /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 (file)
index 0000000..7390dd1
--- /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 <libmemcached/memcached.h>
+ 
+.. 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/ <http://libmemcached.org/>`_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+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 (file)
index 0000000..01c1b31
--- /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.