summaryrefslogtreecommitdiff
path: root/libraries/base/GHC/StaticPtr.hs
diff options
context:
space:
mode:
authorFacundo Domínguez <facundo.dominguez@tweag.io>2017-11-15 11:37:32 -0500
committerBen Gamari <ben@smart-cactus.org>2017-11-15 11:37:55 -0500
commit6dfe9828e2b3bd79e22e89c919b0d1b92273b718 (patch)
tree9cf6e590dc602a2c2f4388a8a4924325e74908c5 /libraries/base/GHC/StaticPtr.hs
parentf5dc8ccc29429d0a1d011f62b6b430f6ae50290c (diff)
downloadhaskell-6dfe9828e2b3bd79e22e89c919b0d1b92273b718.tar.gz
StaticPointers: Clarify documentation
* Document requirement to use the same binaries. * Fix some code comments. Test Plan: ./validate Reviewers: bgamari, mboes, hvr Reviewed By: bgamari, mboes Subscribers: rwbarton, thomie Differential Revision: https://phabricator.haskell.org/D4172
Diffstat (limited to 'libraries/base/GHC/StaticPtr.hs')
-rw-r--r--libraries/base/GHC/StaticPtr.hs5
1 files changed, 5 insertions, 0 deletions
diff --git a/libraries/base/GHC/StaticPtr.hs b/libraries/base/GHC/StaticPtr.hs
index 65ec483577..92829acb73 100644
--- a/libraries/base/GHC/StaticPtr.hs
+++ b/libraries/base/GHC/StaticPtr.hs
@@ -28,6 +28,11 @@
-- table is known as the Static Pointer Table. The reference can then be
-- dereferenced to obtain the value.
--
+-- The various communicating processes need to aggree on the keys used to refer
+-- to the values in the Static Pointer Table, or lookups will fail. Only
+-- processes launched from the same program binary are guaranteed to use the
+-- same set of keys.
+--
-----------------------------------------------------------------------------
module GHC.StaticPtr