]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
OPENSSL_malloc.pod: tfix, wfix in OPENSSL_aligned_alloc description
authorEugene Syromiatnikov <esyr@openssl.org>
Tue, 29 Jul 2025 04:30:50 +0000 (06:30 +0200)
committerNeil Horman <nhorman@openssl.org>
Fri, 8 Aug 2025 16:22:10 +0000 (12:22 -0400)
Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28059)

doc/man3/OPENSSL_malloc.pod

index 5f6c9d3c8bf180970be0f17680a22e51fccdaef1..6e8d350dd306550b0012cbe4ad54eac22fe0510d 100644 (file)
@@ -122,19 +122,19 @@ OPENSSL_malloc(), OPENSSL_realloc(), and OPENSSL_free() are like the
 C malloc(), realloc(), and free() functions.
 OPENSSL_zalloc() calls memset() to zero the memory before returning.
 
-OPENSSL_aligned_alloc() operates just as OPENSSL_malloc does, but it
+OPENSSL_aligned_alloc() operates just as OPENSSL_malloc() does, but it
 allows for the caller to specify an alignment value, for instances in
-which the default alignment of malloc is insufficient for the callers
+which the default alignment of malloc is insufficient for the caller's
 needs.  Note, the alignment value must be a power of 2, and the size
 specified must be a multiple of the alignment.
 NOTE: The call to OPENSSL_aligned_alloc() accepts a 3rd argument, I<freeptr>
 which must point to a void pointer.  On some platforms, there is no available
-library call to obtain memory allocations greater than what malloc provides.  In
-this case, OPENSSL_aligned_alloc implements its own alignment routine,
-allocating additional memory and offsetting the returned pointer to be on the
-requested alignment boundary.  In order to safely free allocations made by this
-method, the caller must return the value in the I<freeptr> variable, rather than
-the returned pointer.
+library call to obtain memory allocations with alignment greater than what
+malloc provides.  In this case, OPENSSL_aligned_alloc() implements its own
+alignment routine, allocating additional memory and offsetting the returned
+pointer to be on the requested alignment boundary.  In order to safely free
+allocations made by this method, the caller must return the value
+in the I<freeptr> variable, rather than the returned pointer.
 
 OPENSSL_clear_realloc() and OPENSSL_clear_free() should be used
 when the buffer at B<addr> holds sensitive information.