From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Thu, 21 Oct 2021 21:08:53 +0000 (-0400)
Subject: Doc: clarify a critical and undocumented aspect of simplehash.h.
X-Git-Tag: REL_15_BETA1~1322
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b1ce6c284366ce1dae120f5d10dd59e8804322ee;p=thirdparty%2Fpostgresql.git

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.
---

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: