| Subject: | Small documentation patch |
Hello,
Here is a documentation patch that corrects the module names
as they appear in the documentation, because there were a few
inconsistenties, particularly in PBS::ProgressBar.
Regards
diff -ru PerlBuildSystem-0.31/PBS/Build/Threaded.pm PerlBuildSystem-0.31-new/PBS/Build/Threaded.pm
--- PerlBuildSystem-0.31/PBS/Build/Threaded.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Build/Threaded.pm 2005-07-02 16:56:50.976412128 +0200
@@ -1,4 +1,3 @@
-
package PBS::Build::Threaded ;
use PBS::Debug ;
@@ -274,7 +273,7 @@
=head1 NAME
-PBS::ThreadedBuild -
+PBS::Build::Threaded -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Build.pm PerlBuildSystem-0.31-new/PBS/Build.pm
--- PerlBuildSystem-0.31/PBS/Build.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Build.pm 2005-07-02 16:56:46.203161534 +0200
@@ -293,7 +293,7 @@
=head1 NAME
-PBS::PBS -
+PBS::Build -
=head1 SYNOPSIS
diff -ru PerlBuildSystem-0.31/PBS/Constants.pm PerlBuildSystem-0.31-new/PBS/Constants.pm
--- PerlBuildSystem-0.31/PBS/Constants.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Constants.pm 2005-07-02 16:57:13.565865556 +0200
@@ -1,4 +1,3 @@
-
package PBS::Constants ;
use 5.006 ;
@@ -114,7 +113,7 @@
__END__
=head1 NAME
-PBS::Constans - definition of constants use within PBS
+PBS::Constants - definition of constants use within PBS
=head1 SYNOPSIS
diff -ru PerlBuildSystem-0.31/PBS/Graph/Html.pm PerlBuildSystem-0.31-new/PBS/Graph/Html.pm
--- PerlBuildSystem-0.31/PBS/Graph/Html.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Graph/Html.pm 2005-07-02 16:57:36.107326520 +0200
@@ -1,4 +1,3 @@
-
package PBS::Graph::Html ;
use PBS::Debug ;
@@ -265,7 +264,7 @@
__END__
=head1 NAME
-PBS::GraphHtml -
+PBS::Graph::Html -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Graph/Snapshots.pm PerlBuildSystem-0.31-new/PBS/Graph/Snapshots.pm
--- PerlBuildSystem-0.31/PBS/Graph/Snapshots.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Graph/Snapshots.pm 2005-07-02 16:57:58.167862989 +0200
@@ -1,4 +1,3 @@
-
package PBS::Graph::Snapshots ;
use PBS::Debug ;
@@ -237,7 +236,7 @@
__END__
=head1 NAME
-PBS::GraphSnapshots -
+PBS::Graph::Snapshots -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Output.pm PerlBuildSystem-0.31-new/PBS/Output.pm
--- PerlBuildSystem-0.31/PBS/Output.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Output.pm 2005-07-02 16:58:20.272392551 +0200
@@ -1,4 +1,3 @@
-
package PBS::Output ;
use 5.006 ;
@@ -310,7 +309,7 @@
__END__
=head1 NAME
-PBS:: -
+PBS::Output -
=head1 SYNOPSIS
diff -ru PerlBuildSystem-0.31/PBS/ProgressBar.pm PerlBuildSystem-0.31-new/PBS/ProgressBar.pm
--- PerlBuildSystem-0.31/PBS/ProgressBar.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/ProgressBar.pm 2005-07-02 17:00:34.666292546 +0200
@@ -3,7 +3,7 @@
package PBS::ProgressBar;
# Nadim Khemir
-# this is a slightly modified Term ::ProgressBar that allows me to color the progress bar
+# this is a slightly modified Term::ProgressBar that allows me to color the progress bar
# the author of the original module didn't want to include the 6 lines changes so I hijacked his module ;-)
#
@@ -18,20 +18,20 @@
# If name is wider than term, trim name
# Don't update progress bar on new?
-=head1 NAME
+=head1 NAME
-Term::ProgressBar - provide a progress meter on a standard terminal
+PBS::ProgressBar - provide a progress meter on a standard terminal
=head1 SYNOPSIS
- use Term::ProgressBar;
+ use PBS::ProgressBar;
- $progress = Term::ProgressBar->new ({count => $count});
+ $progress = PBS::ProgressBar->new ({count => $count});
$progress->update ($so_far);
=head1 DESCRIPTION
-Term::ProgressBar provides a simple progress bar on the terminal, to let the
+PBS::ProgressBar provides a simple progress bar on the terminal, to let the
user know that something is happening, roughly how much stuff has been done,
and maybe an estimate at how long remains.
@@ -62,11 +62,11 @@
#!/usr/bin/perl
- use Term::ProgressBar 2.00;
+ use PBS::ProgressBar 2.00;
use constant MAX => 100_000;
- my $progress = Term::ProgressBar->new(MAX);
+ my $progress = PBS::ProgressBar->new(MAX);
for (0..MAX) {
my $is_power = 0;
@@ -90,7 +90,7 @@
=head2 A smoother bar update
- my $progress = Term::ProgressBar->new($max);
+ my $progress = PBS::ProgressBar->new($max);
for (0..$max) {
my $is_power = 0;
@@ -114,7 +114,7 @@
=head2 A (much) more efficient update
- my $progress = Term::ProgressBar->new({name => 'Powers', count => $max, remove => 1});
+ my $progress = PBS::ProgressBar->new({name => 'Powers', count => $max, remove => 1});
$progress->minor(0);
my $next_update = 0;
@@ -148,7 +148,7 @@
=head2 Using Completion Time Estimation
- my $progress = Term::ProgressBar->new({name => 'Powers',
+ my $progress = PBS::ProgressBar->new({name => 'Powers',
count => $max,
ETA => linear, });
$progress->max_update_rate(1);
@@ -338,7 +338,7 @@
=head2 new
-Create & return a new Term::ProgressBar instance.
+Create & return a new PBS::ProgressBar instance.
=over 4
@@ -412,12 +412,12 @@
=item EXAMPLES
- my $progress = Term::ProgressBar->new(100); # count from 1 to 100
- my $progress = Term::ProgressBar->new({ count => 100 }); # same
+ my $progress = PBS::ProgressBar->new(100); # count from 1 to 100
+ my $progress = PBS::ProgressBar->new({ count => 100 }); # same
# Count to 200 thingies, outputting to stdout instead of stderr,
# prefix bar with 'thingy'
- my $progress = Term::ProgressBar->new({ count => 200,
+ my $progress = PBS::ProgressBar->new({ count => 200,
fh => \*STDOUT,
name => 'thingy' });
@@ -442,7 +442,7 @@
my $target;
croak
- sprintf("Term::ProgressBar::new We don't handle this many arguments: %d",
+ sprintf("PBS::ProgressBar::new We don't handle this many arguments: %d",
scalar @_)
if @_ != 1;
@@ -457,10 +457,10 @@
if ( my @bad = grep ! exists DEFAULTS->{$_}, keys %config ) {
croak sprintf("Input parameters (%s) to %s not recognized\n",
- join(':', @bad), 'Term::ProgressBar::new');
+ join(':', @bad), 'PBS::ProgressBar::new');
}
- croak "Target count required for Term::ProgressBar new\n"
+ croak "Target count required for PBS::ProgressBar new\n"
unless defined $target;
$config{$_} = DEFAULTS->{$_}
@@ -550,7 +550,7 @@
no effect until the next update, but the next update value should be relative
to the new target. So
- $p = Term::ProgressBar({count => 20});
+ $p = PBS::ProgressBar({count => 20});
# Halfway
$p->update(10);
# Double scale
@@ -579,7 +579,7 @@
Minor characters are used on the progress bar to give the user the idea of
progress even when there are so many more tasks than the terminal is wide that
-the granularity would be too great. By default, Term::ProgressBar makes a
+the granularity would be too great. By default, PBS::ProgressBar makes a
guess as to when minor characters would be valuable. However, it may not
always guess right, so this method may be called to force it one way or the
other. Of course, the efficiency saving is minimal unless the client is
diff -ru PerlBuildSystem-0.31/PBS/Rules/Builders.pm PerlBuildSystem-0.31-new/PBS/Rules/Builders.pm
--- PerlBuildSystem-0.31/PBS/Rules/Builders.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Rules/Builders.pm 2005-07-02 17:04:17.470312046 +0200
@@ -1,4 +1,3 @@
-
package PBS::Rules::Builders ;
use PBS::Debug ;
@@ -387,7 +386,7 @@
__END__
=head1 NAME
-PBS::Rules::Builders-
+PBS::Rules::Builders -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Rules/Dependers/Subpbs.pm PerlBuildSystem-0.31-new/PBS/Rules/Dependers/Subpbs.pm
--- PerlBuildSystem-0.31/PBS/Rules/Dependers/Subpbs.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Rules/Dependers/Subpbs.pm 2005-07-02 17:04:57.685998135 +0200
@@ -1,4 +1,3 @@
-
package PBS::Rules::Dependers::Subpbs ;
use PBS::Debug ;
@@ -145,7 +144,7 @@
__END__
=head1 NAME
-PBS::Rules::Dependers-
+PBS::Rules::Dependers::Subpbs -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Rules/Dependers.pm PerlBuildSystem-0.31-new/PBS/Rules/Dependers.pm
--- PerlBuildSystem-0.31/PBS/Rules/Dependers.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Rules/Dependers.pm 2005-07-02 17:04:35.192529637 +0200
@@ -1,4 +1,3 @@
-
package PBS::Rules::Dependers ;
use PBS::Debug ;
@@ -325,7 +324,7 @@
__END__
=head1 NAME
-PBS::Rules::Dependers-
+PBS::Rules::Dependers -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Rules/Metarules.pm PerlBuildSystem-0.31-new/PBS/Rules/Metarules.pm
--- PerlBuildSystem-0.31/PBS/Rules/Metarules.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Rules/Metarules.pm 2005-07-02 17:05:17.538881208 +0200
@@ -1,4 +1,3 @@
-
package PBS::Rules::Metarules ;
use PBS::Debug ;
@@ -145,7 +144,7 @@
__END__
=head1 NAME
-PBS::Rules::Metarules-
+PBS::Rules::Metarules -
=head1 DESCRIPTION
diff -ru PerlBuildSystem-0.31/PBS/Rules.pm PerlBuildSystem-0.31-new/PBS/Rules.pm
--- PerlBuildSystem-0.31/PBS/Rules.pm 2005-06-30 21:07:36.000000000 +0200
+++ PerlBuildSystem-0.31-new/PBS/Rules.pm 2005-07-02 17:03:56.566593955 +0200
@@ -1,4 +1,3 @@
-
package PBS::Rules ;
use PBS::Debug ;
@@ -568,7 +567,7 @@
__END__
=head1 NAME
-PBS::Rules::Rules - Manipulate PBS rules
+PBS::Rules - Manipulate PBS rules
=head1 SYNOPSIS