Fix comment for compact region
authorTakenobu Tani <takenobu.hs@gmail.com>
Thu, 4 May 2017 18:16:49 +0000 (14:16 -0400)
committerBen Gamari <ben@smart-cactus.org>
Thu, 4 May 2017 22:20:44 +0000 (18:20 -0400)
There were old module names:

 * Data.Compact -> GHC.Compact
 * Data.Compact.Internal -> GHC.Compact

This commit is for ghc-8.2 branch.

Test Plan: build

Reviewers: austin, bgamari, hvr, erikd, simonmar

Reviewed By: bgamari

Subscribers: rwbarton, thomie

Differential Revision: https://phabricator.haskell.org/D3522

libraries/base/GHC/IO/Exception.hs
libraries/ghc-compact/GHC/Compact.hs
rts/sm/CNF.c

index 17eda3d..9203f46 100644 (file)
@@ -131,7 +131,7 @@ allocationLimitExceeded = toException AllocationLimitExceeded
 
 -- | Compaction found an object that cannot be compacted.  Functions
 -- cannot be compacted, nor can mutable objects or pinned objects.
--- See 'Data.Compact.compact'.
+-- See 'GHC.Compact.compact'.
 --
 -- @since 4.10.0.0
 newtype CompactionFailed = CompactionFailed String
index ea0663e..375e341 100644 (file)
@@ -104,12 +104,12 @@ import GHC.Types
 --
 -- The cost of compaction is similar to the cost of GC for the same
 -- data, but it is performed only once.  However, because
--- "Data.Compact.compact" does not stop-the-world, retaining internal
+-- "GHC.Compact.compact" does not stop-the-world, retaining internal
 -- sharing during the compaction process is very costly. The user
 -- can choose whether to 'compact' or 'compactWithSharing'.
 --
 -- When you have a @'Compact' a@, you can get a pointer to the actual object
--- in the region using "Data.Compact.getCompact".  The 'Compact' type
+-- in the region using "GHC.Compact.getCompact".  The 'Compact' type
 -- serves as handle on the region itself; you can use this handle
 -- to add data to a specific 'Compact' with 'compactAdd' or
 -- 'compactAddWithSharing' (giving you a new handle which corresponds
index 72ab6f2..f740d05 100644 (file)
@@ -4,7 +4,7 @@
  *
  * GC support for immutable non-GCed structures, also known as Compact
  * Normal Forms (CNF for short). This provides the RTS support for
- * the 'compact' package and the Data.Compact module.
+ * the 'compact' package and the GHC.Compact module.
  *
  * ---------------------------------------------------------------------------*/
 
@@ -51,7 +51,7 @@
   Structure
   ~~~~~~~~~
 
-  * In Data.Compact.Internal we have
+  * In GHC.Compact we have
     data Compact a = Compact Compact# a
 
   * The Compact# primitive object is operated on by the primitives.