postgres.git / summary / log / commit / refs

commit    b1ce6c284366ce1dae120f5d10dd59e8804322ee
Author:   Tom Lane <tgl@sss.pgh.pa.us>
Date:     Thu Oct 21 21:08:53 2021 +0000
First released in: 15.0

    Doc: clarify a critical and undocumented aspect of simplehash.h.
    
    I just got burnt by trying to use pg_malloc instead of pg_malloc0
    with this.  Save the next hacker some time by not leaving this
    API detail undocumented.


 src/include/lib/simplehash.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/include/lib/simplehash.h b/src/include/lib/simplehash.h
index f6cbcd8c176..60ab472540d 100644
--- a/src/include/lib/simplehash.h
+++ b/src/include/lib/simplehash.h
@@ -41,7 +41,7 @@
  *	  - SH_SCOPE - in which scope (e.g. extern, static inline) do function
  *		declarations reside
  *	  - SH_RAW_ALLOCATOR - if defined, memory contexts are not used; instead,
- *	    use this to allocate bytes
+ *	    use this to allocate bytes. The allocator must zero the returned space.
  *	  - SH_USE_NONDEFAULT_ALLOCATOR - if defined no element allocator functions
  *		are defined, so you can supply your own
  *	  The following parameters are only relevant when SH_DEFINE is defined:


[parent: 0c04342b1d3d]