Skip to content

Commit 4716c95

Browse files
committed
Rename blockio to blockio-api
The name `blockio` is already taken on Hackage
1 parent 3470e36 commit 4716c95

File tree

25 files changed

+39
-44
lines changed

25 files changed

+39
-44
lines changed

.github/workflows/check-release-builds.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Check release builds
33
on:
44
push:
55
tags:
6-
- blockio-*
6+
- blockio-api-*
77
- bloomfilter-blocked-*
88
- lsm-tree-*
99

@@ -45,7 +45,7 @@ jobs:
4545
env:
4646
tag-name: ${{ github.ref_name }}
4747
release-build-target: |
48-
${{ startsWith(github.ref_name, 'blockio') && './blockio/blockio.cabal' || startsWith(github.ref_name, 'bloomfilter-blocked') && './bloomfilter-blocked/bloomfilter-blocked.cabal' || startsWith(github.ref_name, 'lsm-tree') && './lsm-tree.cabal' }}
48+
${{ startsWith(github.ref_name, 'blockio-api') && './blockio/blockio-api.cabal' || startsWith(github.ref_name, 'bloomfilter-blocked') && './bloomfilter-blocked/bloomfilter-blocked.cabal' || startsWith(github.ref_name, 'lsm-tree') && './lsm-tree.cabal' }}
4949
5050
steps:
5151
- name: 🗄️ Print release build target

CONTRIBUTING.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,6 @@ has to be enabled, either by setting the flag in
1919
`cabal.project`/`cabal.project.local`, or by passing the flag to the `cabal`
2020
executable using `--flag=+serialblockio`.
2121

22-
> :warning: **When enabling `serialblockio`, disable the
23-
> `cabal.project.blockio-uring` import in `cabal.project`!** Unfortunately, this
24-
> line has to be removed/commented out manually (for now), or the project won't
25-
> build.
26-
2722
Installing `rocksdb` is entirely optional, and only required if one wants to
2823
build or run the `utxo-rocksdb-bench` comparison macro-benchmark.
2924

blockio/CHANGELOG.md renamed to blockio-api/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Revision history for blockio
1+
# Revision history for blockio-api
22

33
## 0.1.0.0 -- YYYY-mm-dd
44

File renamed without changes.
File renamed without changes.

blockio/README.md renamed to blockio-api/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# blockio
1+
# blockio-api
22

33
Perform batches of disk I/O operations. Performing batches of disk I/O can lead
44
to performance improvements over performing each disk I/O operation
@@ -35,15 +35,15 @@ performant implementation is available. Lastly, the abstract interface allows us
3535
to program against the file system in a uniform manner across different
3636
platforms, i.e., operating systems.
3737

38-
The `blockio` library defines the abstract interface for batched I/O. The
38+
The `blockio-api` library defines the abstract interface for batched I/O. The
3939
library is an extension of the
4040
[fs-api](https://hackage.haskell.org/package/fs-api) library, which defines an
41-
abstract interface for (basic) file system I/O. Both `blockio` and `fs-api`
41+
abstract interface for (basic) file system I/O. Both `blockio-api` and `fs-api`
4242
provide an implementation of their interfaces using the real file system in
4343
`IO`.
4444

45-
The `blockio:sim` sub-library defines an implementation of the abstract
46-
interface from `blockio` that *simulates* batched I/O. This sub-library is an
45+
The `blockio-api:sim` sub-library defines an implementation of the abstract
46+
interface from `blockio-api` that *simulates* batched I/O. This sub-library is an
4747
extension of the [fs-sim](https://hackage.haskell.org/package/fs-sim) library,
4848
which defines an implementation of the abstract interface from `fs-api` that
4949
simulates (basic) file system I/O.

blockio/blockio.cabal renamed to blockio-api/blockio-api.cabal

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cabal-version: 3.4
2-
name: blockio
2+
name: blockio-api
33
version: 0.1.0.0
44
synopsis: Perform batches of disk I/O operations.
55
description:
@@ -40,13 +40,13 @@ tested-with: GHC ==9.2 || ==9.4 || ==9.6 || ==9.8 || ==9.10 || ==9.12
4040
source-repository head
4141
type: git
4242
location: https://github.com/IntersectMBO/lsm-tree
43-
subdir: blockio
43+
subdir: blockio-api
4444

4545
source-repository this
4646
type: git
4747
location: https://github.com/IntersectMBO/lsm-tree
48-
subdir: blockio
49-
tag: blockio-0.1.0.0
48+
subdir: blockio-api
49+
tag: blockio-api-0.1.0.0
5050

5151
common warnings
5252
ghc-options:
@@ -121,7 +121,7 @@ test-suite test
121121
build-depends:
122122
, async
123123
, base <5
124-
, blockio
124+
, blockio-api
125125
, bytestring
126126
, fs-api
127127
, primitive
@@ -141,7 +141,7 @@ library sim
141141
exposed-modules: System.FS.BlockIO.Sim
142142
build-depends:
143143
, base >=4.16 && <4.22
144-
, blockio
144+
, blockio-api
145145
, bytestring ^>=0.11 || ^>=0.12
146146
, fs-api ^>=0.4
147147
, fs-sim ^>=0.4
@@ -156,8 +156,8 @@ test-suite test-sim
156156
main-is: Main.hs
157157
build-depends:
158158
, base <5
159-
, blockio
160-
, blockio:sim
159+
, blockio-api
160+
, blockio-api:sim
161161
, fs-api
162162
, fs-sim
163163
, io-classes:strict-stm

0 commit comments

Comments
 (0)