Skip to content

Commit b8a13dd

Browse files
authored
Clarify that ChainSync-client-bench is comparative (#1338)
Add a small comment to the header of the `Main` module to clarify that the benchmark is intended to spot regressions in the client. It is not intended as an absolute measure for performance
2 parents d613d97 + 8e3d8dd commit b8a13dd

File tree

1 file changed

+4
-0
lines changed
  • ouroboros-consensus/bench/ChainSync-client-bench

1 file changed

+4
-0
lines changed

ouroboros-consensus/bench/ChainSync-client-bench/Main.hs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{-# LANGUAGE LambdaCase #-}
22
{-# LANGUAGE NamedFieldPuns #-}
33

4+
-- | This is a comparative benchmark that can be used to spot regressions in the
5+
-- Chain Sync Client. It is not a benchmark intended to provide an absolute
6+
-- measure of performance. For that, it would arguably need to use Cardano
7+
-- blocks instead of Test Blocks
48
module Main (main) where
59

610
import Bench.Consensus.ChainSyncClient.Driver (mainWith)

0 commit comments

Comments
 (0)