Skip to content

Commit e2d80d1

Browse files
committed
Emphasize the importance of the runWith function
1 parent 128b327 commit e2d80d1

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
A new scriv changelog fragment.
3+
4+
Uncomment the section that is right (remove the HTML comment wrapper).
5+
-->
6+
7+
<!--
8+
### Patch
9+
10+
- A bullet item for the Patch category.
11+
12+
-->
13+
<!--
14+
### Non-Breaking
15+
16+
- A bullet item for the Non-Breaking category.
17+
18+
-->
19+
<!--
20+
### Breaking
21+
22+
- A bullet item for the Breaking category.
23+
24+
-->

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/ChainDB.hs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@
4848
-- - The ChainDB is used to create 'Follower's (which in turn contain
4949
-- 'Iterator's).
5050
--
51-
-- These resources must eventually be freed. See function
52-
-- 'Ouroboros.Consensus.Node.runWith' for an example of an approach
53-
-- taken to resource management using a resource registry.
51+
-- These resources must eventually be freed.
5452
--
53+
-- Threads that make use of the ChainDB to allocate resources *MUST* be closed
54+
-- before the ChainDB is closed. See 'Ouroboros.Consensus.Node.runWith' for the
55+
-- approach we follow in consensus to ensure this principle.
5556
module Ouroboros.Consensus.Storage.ChainDB
5657
( module Ouroboros.Consensus.Storage.ChainDB.API
5758
, module Ouroboros.Consensus.Storage.ChainDB.Impl

0 commit comments

Comments
 (0)