Skip to content

Commit

Permalink
Clarify that ChainSync-client-bench is comparative (#1338)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jorisdral authored Dec 4, 2024
2 parents d613d97 + 8e3d8dd commit b8a13dd
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ouroboros-consensus/bench/ChainSync-client-bench/Main.hs
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}

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

import Bench.Consensus.ChainSyncClient.Driver (mainWith)
Expand Down

0 comments on commit b8a13dd

Please sign in to comment.