[commit: ghc] ghc-8.2: Fix comment for compact region (26c041b)
git at git.haskell.org
git at git.haskell.org
Fri May 5 02:54:51 UTC 2017
Repository : ssh://git@git.haskell.org/ghc
On branch : ghc-8.2
Link : http://ghc.haskell.org/trac/ghc/changeset/26c041b694623d33bc5bac0534fbe7150042fdec/ghc
>---------------------------------------------------------------
commit 26c041b694623d33bc5bac0534fbe7150042fdec
Author: Takenobu Tani <takenobu.hs at gmail.com>
Date: Thu May 4 14:16:49 2017 -0400
Fix comment for compact region
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
(cherry picked from commit 4fcaf8e97db89b0c040ca33f0503faf3403b918f)
>---------------------------------------------------------------
26c041b694623d33bc5bac0534fbe7150042fdec
libraries/base/GHC/IO/Exception.hs | 2 +-
libraries/ghc-compact/GHC/Compact.hs | 4 ++--
rts/sm/CNF.c | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/libraries/base/GHC/IO/Exception.hs b/libraries/base/GHC/IO/Exception.hs
index 17eda3d..9203f46 100644
--- a/libraries/base/GHC/IO/Exception.hs
+++ b/libraries/base/GHC/IO/Exception.hs
@@ -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
diff --git a/libraries/ghc-compact/GHC/Compact.hs b/libraries/ghc-compact/GHC/Compact.hs
index ea0663e..375e341 100644
--- a/libraries/ghc-compact/GHC/Compact.hs
+++ b/libraries/ghc-compact/GHC/Compact.hs
@@ -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
diff --git a/rts/sm/CNF.c b/rts/sm/CNF.c
index ed9460e..fbebfab 100644
--- a/rts/sm/CNF.c
+++ b/rts/sm/CNF.c
@@ -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.
More information about the ghc-commits
mailing list