docs: semver

[awesomized/libmemcached] / docs / source / libmemcachedutil / index.rst

diff --git a/docs/source/libmemcachedutil/index.rst b/docs/source/libmemcachedutil/index.rst
index e16691ecd97cff43fdc82a25ec7ab49602db3d49..7507314e4f86d175054f4732f5b5457b32f563be 100644 (file)
--- a/docs/source/libmemcachedutil/index.rst
+++ b/docs/source/libmemcachedutil/index.rst
@@ -1,8 +1,46 @@
-libmemcachedutil API
-====================
+libmemcachedutil - C/C++ utilities extending libmemcached
+=========================================================
+
+Utility library for libmemcached
+
+SYNOPSIS
+--------
+
+#include <libmemcachedutil-|libmemcachedutil_version|/util.h>
+  Compile and link with -lmemcachedutil -lmemcached
+
+DESCRIPTION
+-----------
+
+`libmemcachedutil` is a small and thread-safe client library that provides extra
+functionality built on top of `libmemcached`.
+
+THREADS AND PROCESSES
+---------------------
+
+Do not try to access an instance of `memcached_st` from multiple threads at the
+same time. If you want to access memcached from multiple threads you should
+either clone the `memcached_st`, or use the memcached pool implementation. See
+`memcached_pool`.
 
 .. toctree::
     :titlesonly:
     :caption: Additional Utilities
 
     memcached_pool
+
+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)`
+
+.. only:: html
+
+    * :doc:`../libmemcached`
+