Skip to content

Commit 314b092

Browse files
committed
io-classes: renamed from io-sim-classes
1 parent 638624e commit 314b092

File tree

21 files changed

+27
-27
lines changed

21 files changed

+27
-27
lines changed

io-classes/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Revsion history of io-classes
2+
3+
## 0.1.0.0
4+
5+
* Initial version, not released on Hackage.
6+
7+
## 0.2.0.0
8+
9+
* First version published on Hackage.
10+
* added `lengthTBQueue` to `MonadSTM`; `io-classes` now depends on `stm-2.5.0.0`.
File renamed without changes.
File renamed without changes.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ a G-set for the former. We use
3939
for the former and a newtype wrapper `Time` for the later (provided for this
4040
package). `DiffTime` is used consistently across all the type classes which is
4141
one of the few departures from the `base` interface. One example is
42-
[threadDelay](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadTimer.html#v:threadDela)
42+
[threadDelay](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadTimer.html#v:threadDela)
4343
(provided by `MonadDelay`) which is using `DiffTime` (being in seconds) rather
4444
than passing microseconds as an `Int` - as it is done by `base` package.
4545
Provided `threadDelay` function is safely against overflows, this is especially
@@ -70,19 +70,19 @@ on top of
7070
[ghc-heap](https://gitlab.haskell.org/ghc/ghc/-/tree/master/libraries/ghc-heap)
7171
was successfully used to eliminate such bugs in a large system. We strongly
7272
recommend to use `Control.Monad.Class.MonadSTM.Strict`. It exposes the
73-
[MonadSTM](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM.html#t:MonadSTM)
73+
[MonadSTM](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSTM.html#t:MonadSTM)
7474
interface and gives access to
7575
[StrictTVar](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM-Strict.html#t:StrictTVar)'s
7676
in place of non-strict
77-
[TVar](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSTM.html#t:TVar)'s.
77+
[TVar](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSTM.html#t:TVar)'s.
7878

7979
## Threads API
8080

8181
We draw a line between `base` api and `async` api. The former one is provided
8282
by
83-
[MonadFork](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadFork)
83+
[MonadFork](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadFork)
8484
the latter by
85-
[MonadAsync](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadAsync).
85+
[MonadAsync](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadFork.html#t:MonadAsync).
8686
Both are shallow abstractions around APIs exposed by the `base` and `async`
8787
packages.
8888

@@ -92,5 +92,5 @@ packages.
9292
provides an API to the
9393
[Debug.Trace](https://hackage.haskell.org/package/base/docs/Debug-Trace.html)
9494
eventlog interface.
95-
* [MonadST](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadST.html#t:MonadST): provides a way to lift `ST`-computations.
96-
* [MonadSay](https://hackage.haskell.org/package/io-sim-classes/docs/Control-Monad-Class-MonadSay.html#t:MonadSay): dummy debugging interface
95+
* [MonadST](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadST.html#t:MonadST): provides a way to lift `ST`-computations.
96+
* [MonadSay](https://hackage.haskell.org/package/io-classes/docs/Control-Monad-Class-MonadSay.html#t:MonadSay): dummy debugging interface

io-sim-classes/io-sim-classes.cabal renamed to io-classes/io-classes.cabal

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: io-sim-classes
1+
name: io-classes
22
version: 0.2.0.0
33
synopsis: Type classes for concurrency with STM, ST and timing
44
-- description:
@@ -16,7 +16,7 @@ cabal-version: >=1.10
1616
source-repository head
1717
type: git
1818
location: https://github.com/input-output-hk/ouroboros-network
19-
subdir: io-sim-classes
19+
subdir: io-classes
2020

2121
flag checktvarinvariant
2222
Description: Enable runtime invariant checks on StrictT(M)Var
@@ -81,7 +81,7 @@ test-suite test
8181
other-modules: Test.MonadTimer
8282
default-language: Haskell2010
8383
build-depends: base,
84-
io-sim-classes,
84+
io-classes,
8585

8686
QuickCheck,
8787
tasty,

io-sim-classes/src/Control/Monad/Class/MonadSTM.hs renamed to io-classes/src/Control/Monad/Class/MonadSTM.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class ( Monad stm
110110
modifyTVar' :: TVar_ stm a -> (a -> a) -> stm ()
111111
modifyTVar' v f = readTVar v >>= \x -> writeTVar v $! f x
112112

113-
-- | @since io-sim-classes-0.2.0.0
113+
-- | @since io-classes-0.2.0.0
114114
stateTVar :: TVar_ stm s -> (s -> (a, s)) -> stm a
115115
stateTVar = stateTVarDefault
116116

0 commit comments

Comments
 (0)