The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Bencher-1.062.4
River stage one • 3 direct dependents • 8 total dependents
++
/ Bencher::Manual::HowTo

NAME

Bencher::Manual::HowTo - How-to guides for Bencher

VERSION

This document describes version 1.062.4 of Bencher::Manual::HowTo (from Perl distribution Bencher), released on 2024-02-19.

DESCRIPTION

Keywords: cookbook

TOPIC: GENERAL

TOPIC: MODULES

Update all modules that are used by participants

 % bencher -m Scenario --list-participant-modules | cpanm -n

This can be used to make sure that you are benchmarking the latest version of each module.

Keywords: tip

TOPIC: RUNNER

Picking a runner

By default, bencher runs the benchmark with Dumbbench which has the advantages like fewer required iterations or outliers exclusion. However, you can also use the core module Benchmark (Benchmark.pm) as the runner. To select a runner:

 % bencher -m Scenario --runner Benchmark       ;# select Benchmark.pm
 % bencher -m Scenario --runner Benchmark::Dumb ;# select Dumbbench, the default

If you want to use the default Dumbbench runner, but want to format the result like Benchmark.pm, use the --render-as-benchmark-pm option (since 1.056):

 % bencher -m Scenario --render-as-benchmark-pm

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher.

SEE ALSO

Bencher::Manual::*

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.