The following commit has been merged in the lab-refactor branch:
commit 5c8d83fb8da6b3eed6af7ae5e3472bdf5eb77b66
Author: Niels Thykier <[email protected]>
Date: Thu Sep 29 21:38:33 2011 +0200
Fixed some documentation for L::Processable{,::Package}
Signed-off-by: Niels Thykier <[email protected]>
diff --git a/lib/Lintian/Processable.pm b/lib/Lintian/Processable.pm
index 3f6c6fc..5e1416a 100644
--- a/lib/Lintian/Processable.pm
+++ b/lib/Lintian/Processable.pm
@@ -37,12 +37,12 @@ Lintian::Processable -- An (abstract) object that Lintian
can process
=head1 SYNOPSIS
- use Lintian::Processable;
+ use Lintian::Processable::Package;
# Instantiate via Lintian::Processable::Package
- my $proc = Lintian::Processable::Package->new('binary',
'lintian_2.5.0_all.deb');
- my $pkg_name = $proc->pkg_name();
- my $pkg_version = $proc->pkg_version();
+ my $proc = Lintian::Processable::Package->new ('binary',
'lintian_2.5.0_all.deb');
+ my $pkg_name = $proc->pkg_name;
+ my $pkg_version = $proc->pkg_version;
# etc.
=head1 DESCRIPTION
@@ -56,13 +56,17 @@ together.
=over 4
-=item Lintian::Processable->new($pkg_type, $pkg_path)
+=item Lintian::Processable->new ($pkg_type[, ...])
Creates a new processable of type $pkg_type, which must be one of:
'binary', 'udeb', 'source' or 'changes'
-$pkg_path should be the absolute path to the package file that
-defines this type of processable (e.g. the changes file).
+This rest of the arguments (if any) will be passed to $self->_init,
+which sub-classes must override.
+
+Note: This method should not be called directly via
+Lintian::Processable. Please refer to a sub-class like
+L<Lintian::Processable::Package>.
=cut
diff --git a/lib/Lintian/Processable/Package.pm
b/lib/Lintian/Processable/Package.pm
index 17cda14..7819c3a 100644
--- a/lib/Lintian/Processable/Package.pm
+++ b/lib/Lintian/Processable/Package.pm
@@ -37,11 +37,11 @@ Lintian::Processable::Package -- An object that Lintian can
process
=head1 SYNOPSIS
- use Lintian::Processable;
+ use Lintian::Processable::Package;
- my $proc = Lintian::Processable::Package->new('binary',
'lintian_2.5.0_all.deb');
- my $pkg_name = $proc->pkg_name();
- my $pkg_version = $proc->pkg_version();
+ my $proc = Lintian::Processable::Package->new ('binary',
'lintian_2.5.0_all.deb');
+ my $pkg_name = $proc->pkg_name;
+ my $pkg_version = $proc->pkg_version;
# etc.
=head1 DESCRIPTION
--
Debian package checker
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
Archive: http://lists.debian.org/[email protected]
