X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached.rst;h=f630a391fc8456e2746df90053ef5c28e4332886;hb=aeac01630eed825d8a624e7fd7c107d47bb2e40c;hp=4f85d96c470f93e99bc97e1c04f5de20ec5e6b6c;hpb=bdf3398dac90a54d82aed65099290d51e92d4601;p=awesomized%2Flibmemcached
diff --git a/docs/source/libmemcached.rst b/docs/source/libmemcached.rst
index 4f85d96c..f630a391 100644
--- a/docs/source/libmemcached.rst
+++ b/docs/source/libmemcached.rst
@@ -27,30 +27,28 @@ Memcached. Some of the features provided:
DESCRIPTION
-----------
-"Memcached is a high-performance, distributed memory object caching
-system, generic in nature, but intended for use in speeding up dynamic web
-applications by alleviating database load."
-`http://memcached.org/ `_
-
-`libmemcached` is a small, thread-safe client library for the
-memcached protocol. The code has all been written to allow
-for both web and embedded usage. It handles the work behind routing
-individual keys to specific servers specified by the developer (and values are
-matched based on server order as supplied by the user). It implements
-a modular and consistent method of object distribution.
+"Memcached is a high-performance, distributed memory object caching system,
+generic in nature, but intended for use in speeding up dynamic web applications
+by alleviating database load." `http://memcached.org/ `_
+
+`libmemcached` is a small, thread-safe client library for the memcached
+protocol. The code has all been written to allow for both web and embedded
+usage. It handles the work behind routing individual keys to specific servers
+specified by the developer (and values are matched based on server order as
+supplied by the user). It implements a modular and consistent method of object
+distribution.
There are multiple implemented routing and hashing methods. See the
-:func:`memcached_behavior_set` manpage for more information.
+`memcached_behavior_set` manpage for more information.
-All operations are performed against a :type:`memcached_st` structure.
-These structures can either be dynamically allocated or statically
-allocated and then initialized by :func:`memcached_create`. Functions have
-been written in order to encapsulate the :type:`memcached_st`. It is not
-recommended that you operate directly against the structure.
+All operations are performed against a `memcached_st` structure. These
+structures can either be dynamically allocated or statically allocated and then
+initialized by `memcached_create`. Functions have been written in order to
+encapsulate the `memcached_st`. It is not recommended that you operate directly
+against the structure.
-Nearly all functions return a :type:`memcached_return_t` value.
-This value can be translated to a printable string with
-:type:`memcached_strerror`.
+Nearly all functions return a `memcached_return_t` value. This value can be
+translated to a printable string with `memcached_strerror`.
Objects are stored on servers by hashing keys. The hash value maps the key to a
particular server. All clients understand how this hashing works, so it is
@@ -63,30 +61,16 @@ applications can use the same memcached servers.
Some features of the library must be enabled through `memcached_behavior_set`.
-CONSTANTS
----------
-
-A number of constants have been provided for in the library.
-
-.. only:: man
-
- See :manpage:`libmemcached_constants(3)`.
-
-.. only:: html
-
- See :doc:`libmemcached/constants`.
-
THREADS AND PROCESSES
---------------------
No global variables are used in this library.
-:type:`memcached_st` structures are thread-safe, but when using threads or
-forked processes it is important to keep one instance of :type:`memcached_st`
-per process or thread. Without creating your own locking structures you can not
-share a single :type:`memcached_st`. However, you can call
-:func:`memcached_quit` on a :type:`memcached_st` and then use the resulting
-cloned structure.
+`memcached_st` structures are thread-safe, but when using threads or forked
+processes it is important to keep one instance of `memcached_st` per process or
+thread. Without creating your own locking structures you can not share a single
+`memcached_st`. However, you can call `memcached_quit` on a `memcached_st` and
+then use the resulting cloned structure.
SYSTEMTAP
---------
@@ -104,7 +88,6 @@ CLIENT PROGRAMS
.. only:: man
- :manpage:`memcached(1)`
:manpage:`memaslap(1)`
:manpage:`memcapable(1)`
:manpage:`memcat(1)`
@@ -147,8 +130,8 @@ UTILITY LIBRARIES
.. only:: html
- * :doc:`libhashkit`
- * :doc:`libmemcachedutil`
+ * :doc:`libhashkit/index`
+ * :doc:`libmemcachedutil/index`
SEE ALSO
--------
@@ -156,7 +139,6 @@ SEE ALSO
.. only:: man
:manpage:`memcached(1)`
-
:manpage:`libmemcached_configuration(3)`
:manpage:`libmemcached_examples(3)`