diff options
author | Mattias Andrée <maandree@operamail.com> | 2015-10-18 05:31:35 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2015-10-18 05:31:35 +0200 |
commit | 68d4eb481ba1f71edc2b2597f1db63345e7cd51b (patch) | |
tree | 0b1961f8f090a1548c48ee0aa0c655dd47e62a4d /include | |
parent | rememalign: check mode (diff) | |
download | slibc-68d4eb481ba1f71edc2b2597f1db63345e7cd51b.tar.gz slibc-68d4eb481ba1f71edc2b2597f1db63345e7cd51b.tar.bz2 slibc-68d4eb481ba1f71edc2b2597f1db63345e7cd51b.tar.xz |
m doc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'include')
-rw-r--r-- | include/slibc-alloc.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/include/slibc-alloc.h b/include/slibc-alloc.h index f19982a..3fe31e0 100644 --- a/include/slibc-alloc.h +++ b/include/slibc-alloc.h @@ -212,7 +212,7 @@ void* extalloc(void*, size_t, enum extalloc_mode) * behaviour and pointer alignment can be tuned. * * @param ptr The old allocation, see `realloc` for more details. - * @param boundary The alignment. + * @param boundary The alignment, not checked before necessary. * @param size The new allocation size, see `realloc` for more details. * @param mode `REMEMALIGN_CLEAR`, `REMEMALIGN_INIT` or * `REMEMALIGN_MEMCPY`, or both or neither. @@ -233,8 +233,12 @@ void* rememalign(void*, size_t, size_t, enum rememalign_mode) * - It will never free `ptr`. * - The alignment of new pointers can be specified. * + * This function cannot be used to force realignment, + * the aligment is applied when it is necessary to + * create a new allocation. + * * @param ptr The old allocation, see `realloc` for more details. - * @param boundary The alignment. + * @param boundary The alignment, not checked before necessary. * @param size The new allocation size, see `realloc` for more details. * @return The new allocation, see `realloc` for more details. * |