Safe Haskell | None |
---|---|
Language | Haskell2010 |
Convenience module that reexports the necessary bits.
- defaultMainModifyConfig :: (Config -> Config) -> IO ()
- addPlugin :: Plugin p => p -> PlugConf p -> Config -> Config
- addBenchmarks :: [Benchmark DefaultParamMeaning] -> Config -> Config
- data Flag
- = ParBench
- | BenchsetName String
- | BinDir FilePath
- | NoRecomp
- | NoCabal
- | NoClean
- | ShortRun
- | KeepGoing
- | NumTrials String
- | SkipTo String
- | RunOnly Int
- | RetryFailed Int
- | RunID String
- | CIBuildID String
- | ForceHostName String
- | CabalPath String
- | GHCPath String
- | ShowHelp
- | ShowVersion
- | ShowBenchmarks
- | DisablePlug String
- all_cli_options :: [(String, [OptDescr Flag])]
- fullUsageInfo :: String
- module HSBencher.Types
- module HSBencher.Harvesters
The main entrypoints for building new benchmark suites.
defaultMainModifyConfig :: (Config -> Config) -> IO () Source
An even more flexible version allows the user to install a hook which modifies the configuration just before bencharking begins. All trawling of the execution environment (command line args, environment variables) happens BEFORE the user sees the configuration.
This function doesn't take a benchmark list separately, because that simply
corresponds to the benchlist
field of the output Config
.
addPlugin :: Plugin p => p -> PlugConf p -> Config -> Config Source
This abstracts over the actions we need to take to properly add
an additional plugin to the Config
.
addBenchmarks :: [Benchmark DefaultParamMeaning] -> Config -> Config Source
Command-line configuration
Command line flags to the benchmarking executable.
all_cli_options :: [(String, [OptDescr Flag])] Source
fullUsageInfo :: String Source
Multiple lines of usage info help docs.
All the types necessary for configuration and customization
Don't import the module below directly, but do click on this link to read its documentation.
module HSBencher.Types
module HSBencher.Harvesters