view release on metacpan or  search on metacpan

bin/benchmark-perlformance  view on Meta::CPAN

=item --tapdescription="some description"

When given together with C<--outstyle=yamlish> this will prepend the
YAMLish with a TAP line

  ok some description

This makes it easier for wrappers to embed the output into TAP which
otherwise need to differentiate between output (verbose and other) and
the YAMLish.

=item --indent=2

This indents the output of C<--outstyle=yamlish> by some spaces (2 in
the example). Together with C<--tapdescription> it makes an TAP v13
style structured diagnostics block which can, for instance, be
evaluated using L<TAP::DOM>.

=item --useforks

By setting this you can activate the C<forks> drop-in replacement for
threads.

See
L<Benchmark::Perl::Formance::Plugin::Threads|Benchmark::Perl::Formance::Plugin::Threads>.

=item -Dkey=value

With this you can configure some plugins by defining key/value pairs.

=back

=head1 ENVIRONMENT VARIABLES

There are some options available.

=over 4

=item PERLFORMANCE_SALEARN

See L<Benchmark::Perl::Formance::Plugin::SpamAssassin|Benchmark::Perl::Formance::Plugin::SpamAssassin>. Contains
the path to the "sa-learn" executable.

=item PERLFORMANCE_THREADCOUNT

See
L<Benchmark::Perl::Formance::Plugin::Threads|Benchmark::Perl::Formance::Plugin::Threads>. Use
this many count of threads. Default is 16.

=back

=head1 PLUGINS

Please read the documentation for the used plugins, as they might accept
special configuration, usually via C<-Dkey=value> options.

=over 4

=item L<Benchmark::Perl::Formance::Plugin::SpamAssassin|Benchmark::Perl::Formance::Plugin::SpamAssassin>

Macro benchmark. Run sa-learn learning tool from SpamAssassin, which stresses string, regex and data structures operations.

=item L<Benchmark::Perl::Formance::Plugin::Mem|Benchmark::Perl::Formance::Plugin::Mem>

Micro benchmarks. Stress memory operations.

=item L<Benchmark::Perl::Formance::Plugin::Prime|Benchmark::Perl::Formance::Plugin::Prime>

Micro benchmarks. Prime numbers.

=item L<Benchmark::Perl::Formance::Plugin::DPath|Benchmark::Perl::Formance::Plugin::DPath>

Macro benchmark. Use DPath to stress lookup, traversing and copying data structures.

=item L<Benchmark::Perl::Formance::Plugin::Rx|Benchmark::Perl::Formance::Plugin::Rx>

Micro benchmarks. Regular expressions, basic functions and pathological regex stressing.

=item L<Benchmark::Perl::Formance::Plugin::RxCmp|Benchmark::Perl::Formance::Plugin::RxCmp>

Micro benchmarks. Compare differnet regex engines (pluggable since Perl 5.10).

=item L<Benchmark::Perl::Formance::Plugin::RegexpCommonTS|Benchmark::Perl::Formance::Plugin::RegexpCommonTS>

Micro benchmarks. Stress regexes by running the Regexp::Common testsuite.

=item L<Benchmark::Perl::Formance::Plugin::MatrixReal|Benchmark::Perl::Formance::Plugin::MatrixReal>

Micro benchmarks. Pure Perl matrix operations.

=item L<Benchmark::Perl::Formance::Plugin::Fib|Benchmark::Perl::Formance::Plugin::Fib>

Micro benchmarks. Fibonnacci numbers to stress recursion and function calls.

=item L<Benchmark::Perl::Formance::Plugin::FibOO|Benchmark::Perl::Formance::Plugin::FibOO>

Micro benchmarks. Fibonnacci numbers to stress recursion and method calls, with plain Perl OO.

=item L<Benchmark::Perl::Formance::Plugin::FibOOSig|Benchmark::Perl::Formance::Plugin::FibOOSig>

Micro benchmarks. Fibonnacci numbers to stress recursion and method calls, with plain Perl OO using 5.20 signatures.

=item L<Benchmark::Perl::Formance::Plugin::FibMoose|Benchmark::Perl::Formance::Plugin::FibMoose>

Micro benchmarks. Fibonnacci numbers to stress recursion and method calls, with Moose.

=item L<Benchmark::Perl::Formance::Plugin::FibMouse|Benchmark::Perl::Formance::Plugin::FibMouse>

Micro benchmarks. Fibonnacci numbers to stress recursion and method calls, with Mouse.

=item L<Benchmark::Perl::Formance::Plugin::FibMXDeclare|Benchmark::Perl::Formance::Plugin::FibMXDeclare>

Micro benchmarks. Fibonnacci numbers to stress recursion and method calls, with MooseX::Declare.

=item L<Benchmark::Perl::Formance::Plugin::Threads|Benchmark::Perl::Formance::Plugin::Threads>

Micro benchmarks. Stress thread handling.

=item L<Benchmark::Perl::Formance::Plugin::ThreadsShared|Benchmark::Perl::Formance::Plugin::ThreadsShared>

Micro benchmarks. Stress thread handling with shared variables.

=item L<Benchmark::Perl::Formance::Plugin::PerlCritic|Benchmark::Perl::Formance::Plugin::PerlCritic>

Macro benchmarks. Run PerlCritic on itself.

=item L<Benchmark::Perl::Formance::Plugin::Shootout|Benchmark::Perl::Formance::Plugin::Shootout>

Micro benchmarks. Runs some Perl benchmarks from the Language Shootout on alioth.debian.org.

=item L<Benchmark::Perl::Formance::Plugin::P6STD|Benchmark::Perl::Formance::Plugin::P6STD>

Macro benchmarks. Stress using Perl6/Perl5 tools around Perl6 STD.pm.

=back

=head1 AUTHOR

Steffen Schwigon <ss5@renormalist.net>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Steffen Schwigon.

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

=cut