summaryrefslogtreecommitdiff
path: root/libraries/base/Foreign.hs
diff options
context:
space:
mode:
authorSimon Marlow <marlowsd@gmail.com>2010-07-20 08:28:04 +0000
committerSimon Marlow <marlowsd@gmail.com>2010-07-20 08:28:04 +0000
commit73bd02b6e03ff1fbd508ad222c39f5cbd1c006b2 (patch)
tree85370b07f80f41f52d09afa66c0da699689753ce /libraries/base/Foreign.hs
parent80d8b2fb62f725c7d04dc03d888e781153d03d72 (diff)
downloadhaskell-73bd02b6e03ff1fbd508ad222c39f5cbd1c006b2.tar.gz
docs: mention that Foreign.unsafePerformIO is deprecated
We can't actually deprecate it without introducing a name clash between Foreign.unsafePerformIO and System.IO.Unsafe.unsafePerformIO
Diffstat (limited to 'libraries/base/Foreign.hs')
-rw-r--r--libraries/base/Foreign.hs6
1 files changed, 4 insertions, 2 deletions
diff --git a/libraries/base/Foreign.hs b/libraries/base/Foreign.hs
index 622ec9332a..5976c20985 100644
--- a/libraries/base/Foreign.hs
+++ b/libraries/base/Foreign.hs
@@ -24,8 +24,10 @@ module Foreign
, module Foreign.Storable
, module Foreign.Marshal
- -- | For compatibility with the FFI addendum only. The recommended
- -- place to get this from is "System.IO.Unsafe".
+ -- | 'unsafePerformIO' is exported here for backwards
+ -- compatibility reasons only. For doing local marshalling in
+ -- the FFI, use 'unsafeLocalState'. For other uses, see
+ -- 'System.IO.Unsafe.unsafePerformIO'.
, unsafePerformIO
) where