docs: sanitize
authorMichael Wallner <mike@php.net>
Fri, 28 Feb 2020 15:41:20 +0000 (16:41 +0100)
committerMichael Wallner <mike@php.net>
Fri, 28 Feb 2020 15:41:20 +0000 (16:41 +0100)
docs/source/libmemcached/memcached_memory_allocators.rst

index f3fef087da260a02179a6d82ef74441e958f98a8..760f3d073e6b283d116c83064535a6e8864d3609 100644 (file)
@@ -1,14 +1,13 @@
 Use custom allocators for embedded usage
 ========================================
 
-.. index:: object: memcached_st
-
 Manage memory allocator functions
 
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+  Compile and link with -lmemcached
 
 .. function:: 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)
 
@@ -16,56 +15,62 @@ SYNOPSIS
 
 .. function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
 
-.. function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
-
-.. function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
+.. type:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
 
-.. function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
+.. type:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
 
-.. function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
+.. type:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
 
-Compile and link with -lmemcached
+.. type:: 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. This enables libmemcached to be used inside of applications that have their own malloc implementation.
+`libmemcached` allows you to specify your own memory allocators, optimized for
+your application. This enables libmemcached to be used inside of applications
+that have their own malloc implementation.
 
-:func:`memcached_set_memory_allocators` is used to set the memory
-allocators used by the memcached instance specified by ptr. Please note that 
-you cannot override only one of the memory allocators, you have to specify a 
-complete new set if you want to override one of them. All of the memory 
-allocation functions should behave as specified in the C99 standard. Specify 
-NULL as all functions to reset them to the default values.
+:func:`memcached_set_memory_allocators` is used to set the memory allocators
+used by the memcached instance specified by ptr. Please note that you cannot
+override only one of the memory allocators, you have to specify a complete new
+set if you want to override one of them. All of the memory allocation functions
+should behave as specified in the C99 standard. Specify NULL as all functions to
+reset them to the default values.
 
-:func:`memcached_get_memory_allocators` is used to get the currently used
-memory allocators by a memcached handle.
+:func:`memcached_get_memory_allocators` is used to get the currently used memory
+allocators by a memcached handle.
 
-:func:`memcached_get_memory_allocators_context` returns the void \* that
-was passed in during the call to :func:`memcached_set_memory_allocators`.
+:func:`memcached_get_memory_allocators_context` returns the void \* that was
+passed in during the call to :func:`memcached_set_memory_allocators`.
 
-The first argument to the memory allocator functions is a pointer to a
-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.
+The first argument to the memory allocator functions is a pointer to a 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
-passed to them. This was so that customer allocators could have their
-own space for memory.
+passed to them. This was so that customer allocators could have their own space
+for memory.
 
 RETURN
 ------
 
-:func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS`
-upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set 
-of function pointers.
+:func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS` upon success,
+and `MEMCACHED_FAILURE` if you don't pass a complete set of function pointers.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`../libmemcached`
+    * :doc:`memcached_strerror`