summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOleg Grenrus <oleg.grenrus@iki.fi>2021-07-10 13:53:04 +0300
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-09-22 08:23:08 -0400
commit104bf6bfa0d52f6b51992df98dcc17232fc7b75d (patch)
tree505761486c597c554ed033be3684714b8f7e7947
parentd99fc2508204c59cfc83d8a68718cf930ccc74b2 (diff)
downloadhaskell-104bf6bfa0d52f6b51992df98dcc17232fc7b75d.tar.gz
Clarify that malloc, free etc. are the ones from stdlib.h
-rw-r--r--libraries/base/Foreign/Marshal/Alloc.hs5
1 files changed, 5 insertions, 0 deletions
diff --git a/libraries/base/Foreign/Marshal/Alloc.hs b/libraries/base/Foreign/Marshal/Alloc.hs
index 76398b80a6..3d20393368 100644
--- a/libraries/base/Foreign/Marshal/Alloc.hs
+++ b/libraries/base/Foreign/Marshal/Alloc.hs
@@ -37,6 +37,11 @@
-- aligned for that type. Array allocation routines need to obey the same
-- alignment constraints for each array element.
--
+-- The underlying implementation is wrapping the @<stdlib.h>@
+-- @malloc@, @realloc@, and @free@.
+-- In other words it should be safe to allocate using C-@malloc@,
+-- and free memory with 'free' from this module.
+--
-----------------------------------------------------------------------------
module Foreign.Marshal.Alloc (