Rename compact to ghc-compact.
[ghc.git] / libraries / ghc-compact / ghc-compact.cabal
similarity index 58%
rename from libraries/compact/compact.cabal
rename to libraries/ghc-compact/ghc-compact.cabal
index b80dc59..829e56c 100644 (file)
@@ -1,19 +1,20 @@
-name:           compact
-version:        1.0.0.0
+name:           ghc-compact
+version:        0.1.0.0
 -- NOTE: Don't forget to update ./changelog.md
 license:        BSD3
 license-file:   LICENSE
 maintainer:     libraries@haskell.org
-bug-reports:    http://ghc.haskell.org/trac/ghc/newticket?component=libraries/compact
+bug-reports:    http://ghc.haskell.org/trac/ghc/newticket?component=libraries/ghc-compact
 synopsis:       In memory storage of deeply evaluated data structure
 category:       Data
 description:
-    This package provides a single data structure, called a Compact,
-    which holds a single haskell object in fully evaluated form. The
-    invariant is, no pointers live inside the struct that point outside
-    it, which ensures efficient garbage collection without ever reading
-    the structure contents (effectively, it works as a manually managed
-    "oldest generation" which is never freed until the whole is released).
+    This package provides minimal functionality for working with
+    "compact regions", which hold a fully evaluated Haskell object graph.
+    These regions maintain the invariant that no pointers live inside the struct
+    that point outside it, which ensures efficient garbage collection without
+    ever reading the structure contents (effectively, it works as a manually
+    managed "oldest generation" which is never freed until the whole is
+    released).
 
     Internally, the struct is stored a single contiguous block of memory,
     which allows efficient serialization and deserialization of structs
@@ -25,7 +26,7 @@ tested-with:    GHC==7.11
 source-repository head
   type:     git
   location: http://git.haskell.org/ghc.git
-  subdir:   libraries/compact
+  subdir:   libraries/ghc-compact
 
 library
   default-language: Haskell2010
@@ -40,6 +41,5 @@ library
                  bytestring >= 0.10.6.0
   ghc-options: -Wall
 
-  exposed-modules: Data.Compact
-                   Data.Compact.Internal
-                   Data.Compact.Serialized
+  exposed-modules: GHC.Compact
+                   GHC.Compact.Serialized