projects
/
m6w6
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
docs: sanitize
[m6w6/libmemcached]
/
docs
/
source
/
libmemcachedutil.rst
diff --git
a/docs/source/libmemcachedutil.rst
b/docs/source/libmemcachedutil.rst
index 29cc7dbfe078319eaf00f0aa2f0faa2df8e44035..369600ce7b3b130ddbbc9fc0d9c2a04a9fc4088c 100644
(file)
--- a/
docs/source/libmemcachedutil.rst
+++ b/
docs/source/libmemcachedutil.rst
@@
-1,56
+1,41
@@
-============================
-Introducing libmemcachedutil
-============================
+libmemcachedutil - C/C++ utilities extending libmemcached
+=========================================================
Utility library for libmemcached
Utility library for libmemcached
-
---------
SYNOPSIS
--------
SYNOPSIS
--------
-.. code-block:: c
-
- cc [ flag ... ] file ... -lmemcachedutil
-
- #include <libmemcached/memcached_util.h>
-
-
+#include <libmemcachedutil-|libmemcached_version|/util.h>
+ Compile and link with -lmemcachedutil
------------
DESCRIPTION
-----------
DESCRIPTION
-----------
+`libmemcachedutil` is a small and thread-safe client library that
+provides extra functionality built on top of `libmemcached`.
-:program:`libmemcachedutil` is a small and thread-safe client library that
-provides extra functionality built on top of :program:`libmemcached`.
-
-
--------
THREADS
-------
THREADS
-------
-
-Do not try to access an instance of :c:type:`memcached_st` from multiple threads
+Do not try to access an instance of :type:`memcached_st` from multiple threads
at the same time. If you want to access memcached from multiple threads
at the same time. If you want to access memcached from multiple threads
-you should either clone the :c:type:`memcached_st`, or use the memcached pool
-implementation. see :c:func:`memcached_pool_create`.
-
-
-----
-HOME
-----
-
+you should either clone the :type:`memcached_st`, or use the memcached pool
+implementation. See :func:`memcached_pool_create`.
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
---------
SEE ALSO
--------
SEE ALSO
--------
+.. only:: man
+
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_pool(3)`
+ :manpage:`memcached_pool_destroy(3)`
+ :manpage:`memcached_pool_pop(3)`
+ :manpage:`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)`
+.. only:: html
+ * :doc:`../libmemcached`
+ * :doc:`libmemcachedutil/memcached_pool`