Merge #3222

3222: io-classes: renamed from io-sim-classes r=coot a=coot



Co-authored-by: Marcin Szamotulski <[email protected]>

Author: iohk-bors[bot]

io-classes/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Revsion history of io-classes
+
+## 0.1.0.0
+
+* Initial version, not released on Hackage.
+
+## 0.2.0.0
+
+* First version published on Hackage.
+* added `lengthTBQueue` to `MonadSTM`; `io-classes` now depends on `stm-2.5.0.0`.

io-sim-classes/LICENSE renamed to io-classes/LICENSE

@@ -39,7 +39,7 @@ a G-set for the former.  We use
 for the former and a newtype wrapper `Time` for the later (provided for this
 package).  `DiffTime` is used consistently across all the type classes which is
 one of the few departures from the `base` interface.  One example is
-[threadDelay](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadTimer.html#v:threadDela)
+[threadDelay](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadTimer.html#v:threadDela)
 (provided by `MonadDelay`) which is using `DiffTime` (being in seconds) rather
 than passing microseconds as an `Int` - as it is done by `base` package.
 Provided `threadDelay` function is safely against overflows, this is especially
@@ -70,19 +70,19 @@ on top of
 [ghc-heap](https://gitlab.haskell.org/ghc/ghc/-/tree/master/libraries/ghc-heap)
 was successfully used to eliminate such bugs in a large system.  We strongly
 recommend to use `Control.Monad.Class.MonadSTM.Strict`.  It exposes the
-[MonadSTM](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM.html#t:MonadSTM)
+[MonadSTM](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSTM.html#t:MonadSTM)
 interface and gives access to
 [StrictTVar](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM-Strict.html#t:StrictTVar)'s
 in place of non-strict
-[TVar](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM.html#t:TVar)'s.
+[TVar](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSTM.html#t:TVar)'s.
 
 ## Threads API
 
 We draw a line between `base` api and `async` api.  The former one is provided
 by
-[MonadFork](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadFork)
+[MonadFork](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadFork)
 the latter by
-[MonadAsync](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadAsync).
+[MonadAsync](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadAsync).
 Both are shallow abstractions around APIs exposed by the `base` and `async`
 packages.
 
@@ -92,5 +92,5 @@ packages.
   provides an API to the
   [Debug.Trace](https://hackage.haskell.org/package/base/docs/Debug-Trace.html)
   eventlog interface.
-* [MonadST](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadST.html#t:MonadST): provides a way to lift `ST`-computations.
-* [MonadSay](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSay.html#t:MonadSay): dummy debugging interface
+* [MonadST](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadST.html#t:MonadST): provides a way to lift `ST`-computations.
+* [MonadSay](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSay.html#t:MonadSay): dummy debugging interface

io-sim-classes/NOTICE renamed to io-classes/NOTICE

@@ -1,4 +1,4 @@
-name:                io-sim-classes
+name:                io-classes
 version:             0.2.0.0
 synopsis:            Type classes for concurrency with STM, ST and timing
 -- description:
@@ -16,7 +16,7 @@ cabal-version:       >=1.10
 source-repository head
   type:     git
   location: https://github.com/input-output-hk/ouroboros-network
-  subdir:   io-sim-classes
+  subdir:   io-classes
 
 flag checktvarinvariant
   Description: Enable runtime invariant checks on StrictT(M)Var
@@ -81,7 +81,7 @@ test-suite test
   other-modules:       Test.MonadTimer
   default-language:    Haskell2010
   build-depends:       base,
-                       io-sim-classes,
+                       io-classes,
 
                        QuickCheck,
                        tasty,

io-sim-classes/README.md renamed to io-classes/README.md

@@ -110,7 +110,7 @@ class ( Monad stm
   modifyTVar'  :: TVar_ stm a -> (a -> a) -> stm ()
   modifyTVar' v f = readTVar v >>= \x -> writeTVar v $! f x
 
-  -- | @since io-sim-classes-0.2.0.0
+  -- | @since io-classes-0.2.0.0
   stateTVar    :: TVar_ stm s -> (s -> (a, s)) -> stm a
   stateTVar    = stateTVarDefault