From: Simon Marlow <simonmar@microsoft.com>
Date: Wed, 16 May 2007 08:20:19 +0000 (+0000)
Subject: correct the documentation for newForeignPtr
X-Git-Tag: directory_2007-05-24~6
X-Git-Url: http://git.megacz.com/?p=haskell-directory.git;a=commitdiff_plain;h=147524c1f05f6e1bf721c1b35fd0d8672f25a883

correct the documentation for newForeignPtr
---

diff --git a/Foreign/ForeignPtr.hs b/Foreign/ForeignPtr.hs
index 160bf3c..21485db 100644
--- a/Foreign/ForeignPtr.hs
+++ b/Foreign/ForeignPtr.hs
@@ -105,8 +105,9 @@ newForeignPtr :: FinalizerPtr a -> Ptr a -> IO (ForeignPtr a)
 -- after the last reference to the foreign object is dropped.  Note that there
 -- is no guarantee on how soon the finaliser is executed after the last
 -- reference was dropped; this depends on the details of the Haskell storage
--- manager. The only guarantee is that the finaliser runs before the program
--- terminates.
+-- manager.  Indeed, there is no guarantee that the finalizer is executed at
+-- all; a program may exit with finalizers outstanding.  (This is true
+-- of GHC, other implementations may give stronger guarantees).
 newForeignPtr finalizer p
   = do fObj <- newForeignPtr_ p
        addForeignPtrFinalizer finalizer fObj