summaryrefslogtreecommitdiff
path: root/lib/Benchmark.pm
diff options
context:
space:
mode:
authorGurusamy Sarathy <gsar@cpan.org>1999-12-08 18:29:02 +0000
committerGurusamy Sarathy <gsar@cpan.org>1999-12-08 18:29:02 +0000
commit8a4f6ac230f3943b15bcb439d434cc52e5da1bc3 (patch)
tree8aeb8e2cf089fe3975d9c88cb90e8cfc916f593e /lib/Benchmark.pm
parente8347627432a616ec1485de221b2cd8c9e311c8b (diff)
downloadperl-8a4f6ac230f3943b15bcb439d434cc52e5da1bc3.tar.gz
documentation tweaks from M. J. T. Guy, Micheal Schwern, and
Tim Meadowcroft p4raw-id: //depot/perl@4666
Diffstat (limited to 'lib/Benchmark.pm')
-rw-r--r--lib/Benchmark.pm29
1 files changed, 18 insertions, 11 deletions
diff --git a/lib/Benchmark.pm b/lib/Benchmark.pm
index 83331aab39..487ddd5717 100644
--- a/lib/Benchmark.pm
+++ b/lib/Benchmark.pm
@@ -2,17 +2,7 @@ package Benchmark;
=head1 NAME
-Benchmark - benchmark running times of code
-
-timethis - run a chunk of code several times
-
-timethese - run several chunks of code several times
-
-cmpthese - print results of timethese as a comparison chart
-
-timeit - run a chunk of code and see how long it goes
-
-countit - see how many times a chunk of code runs in a given time
+Benchmark - benchmark running times of Perl code
=head1 SYNOPSIS
@@ -63,6 +53,17 @@ countit - see how many times a chunk of code runs in a given time
The Benchmark module encapsulates a number of routines to help you
figure out how long it takes to execute some code.
+timethis - run a chunk of code several times
+
+timethese - run several chunks of code several times
+
+cmpthese - print results of timethese as a comparison chart
+
+timeit - run a chunk of code and see how long it goes
+
+countit - see how many times a chunk of code runs in a given time
+
+
=head2 Methods
=over 10
@@ -322,6 +323,10 @@ The system time of the null loop might be slightly
more than the system time of the loop with the actual
code and therefore the difference might end up being E<lt> 0.
+=head1 SEE ALSO
+
+L<Devel::DProf> - a Perl code profiler
+
=head1 AUTHORS
Jarkko Hietaniemi <F<jhi@iki.fi>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>
@@ -357,6 +362,8 @@ use Exporter;
@EXPORT_OK=qw(timesum cmpthese countit
clearcache clearallcache disablecache enablecache);
+$VERSION = 1.00;
+
&init;
sub init {