X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_memory_allocators.rst;h=7f1cd10e49d5a79d4130fc5497589eaccd56acd9;hb=72bc4b04c594da7f040ce699ac38d45f4a5a4704;hp=83c96b6b5d02b2776ced995f3e31968f44e15255;hpb=1eae35aca01e152e10113cd97b7571ebd6eb5bd9;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst
index 83c96b6b..7f1cd10e 100644
--- a/docs/memcached_memory_allocators.rst
+++ b/docs/memcached_memory_allocators.rst
@@ -1,78 +1,52 @@
-.. highlight:: perl
+========================================
+Use custom allocators for embedded usage
+========================================
 
 
-****
-NAME
-****
+Manage memory allocator functions
 
 
-memcached_set_memory_allocators, memcached_get_memory_allocators, memcached_set_memory_allocators_context - Manage memory allocator functions
-
-
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
+--------
 
 
 
 .. code-block:: perl
 
-   #include <memcached.h>
+   #include <libmemcached/memcached.h>
  
-   memcached_return_t
-     memcached_set_memory_allocators (memcached_st *ptr,
-                                      memcached_malloc_fn mem_malloc,
-                                      memcached_free_fn mem_free,
-                                      memcached_realloc_fn mem_realloc,
-                                      memcached_calloc_fn mem_calloc,
- 				     void *context);
+   memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
  
-   void
-     memcached_get_memory_allocators (memcached_st *ptr,
-                                      memcached_malloc_fn *mem_malloc,
-                                      memcached_free_fn *mem_free,
-                                      memcached_realloc_fn *mem_realloc,
-                                      memcached_calloc_fn *mem_calloc);
+   void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
  
-   void * 
-     memcached_get_memory_allocators_context(const memcached_st *ptr);
+   void * memcached_get_memory_allocators_context(const memcached_st *ptr);
  
-   void *
-     (*memcached_malloc_fn) (memcached_st *ptr, const size_t size,
-     			    void *context);
+   void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
  
-   void *
-     (*memcached_realloc_fn) (memcached_st *ptr, void *mem,
-                              const size_t size,
- 			     void *context);
+   void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
  
-   void
-     (*memcached_free_fn) (memcached_st *ptr, void *mem,
-     			  void *context);
+   void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
  
-   void *
-   (*memcached_calloc_fn) (memcached_st *ptr,
-   			  size_t nelem,
-                           const size_t elsize,
- 			  void *context);
+   void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) allows you to specify your own memory allocators optimized
-for your application.
+for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
 
 memcached_set_memory_allocators() is used to set the memory allocators used
 by the memcached instance specified by ptr. Please note that you cannot
@@ -92,9 +66,9 @@ memcached structure, the is passed as const and you will need to clone
 it in order to make use of any operation which would modify it.
 
 
-*****
+-----
 NOTES
-*****
+-----
 
 
 In version 0.38 all functions were modified to have a context void pointer
@@ -102,37 +76,26 @@ passed to them. This was so that customer allocators could have their
 own space for memory.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
 and MEMCACHED_FAILURE if you don't pass a complete set of function pointers.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-Trond Norbye, <trond.norbye@gmail.com>
-Brian Aker, <brian@tangent.orf<gt>
-
-
-********
+--------
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
+--------
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`