Skip to content

Commit 5e66a72

Browse files
committed
Emphasize the importance of the runWith function
1 parent 8955939 commit 5e66a72

File tree

1 file changed

+4
-3
lines changed
  • ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage

1 file changed

+4
-3
lines changed

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)