summaryrefslogtreecommitdiff
path: root/libraries/base/GHC/Stable.hs
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/base/GHC/Stable.hs')
-rw-r--r--libraries/base/GHC/Stable.hs2
1 files changed, 2 insertions, 0 deletions
diff --git a/libraries/base/GHC/Stable.hs b/libraries/base/GHC/Stable.hs
index fd4534133c..4c8123e07c 100644
--- a/libraries/base/GHC/Stable.hs
+++ b/libraries/base/GHC/Stable.hs
@@ -44,6 +44,8 @@ garbage collection (ordinary references may be relocated during garbage
collection). Consequently, stable pointers can be passed to foreign code,
which can treat it as an opaque reference to a Haskell value.
+The @StablePtr@ 0 is reserved for representing NULL in foreign code.
+
A value of type @StablePtr a@ is a stable pointer to a Haskell
expression of type @a@.
-}