[SCM] Debian package checker branch, master, updated. 2.5.6-69-g4ae299f
The following commit has been merged in the master branch:
commit 4ae299f72fd65b8ad1339d05bbe5b0352fd44790
Author: Niels Thykier <niels@thykier.net>
Date: Sat Apr 7 23:27:20 2012 +0200
lib/*: Minor pod updates and L<> fixes
Signed-off-by: Niels Thykier <niels@thykier.net>
diff --git a/lib/Lintian/CheckScript.pm b/lib/Lintian/CheckScript.pm
index 2676dfe..3cc5237 100644
--- a/lib/Lintian/CheckScript.pm
+++ b/lib/Lintian/CheckScript.pm
@@ -152,9 +152,9 @@ sub is_check_type {
return $self->{'type-table'}->{$type};
}
-=item $cs->get_tag ($tag)
+=item $cs->get_tag ($tagname)
-Return the L<$tag|Lintian::Info::Tag> or undef (if the tag is not in
+Return the L<tag|Lintian::Info::Tag> or undef (if the tag is not in
this check).
=cut
diff --git a/lib/Lintian/Collect.pm b/lib/Lintian/Collect.pm
index efd8c15..4bfddb8 100644
--- a/lib/Lintian/Collect.pm
+++ b/lib/Lintian/Collect.pm
@@ -121,8 +121,8 @@ Lintian::Collect - Lintian interface to package data collection
=head1 SYNOPSIS
- my ($name, $type) = ('foobar', 'udeb');
- my $collect = Lintian::Collect->new($name, $type);
+ my ($name, $type, $dir) = ('foobar', 'udeb', '/some/abs/path');
+ my $collect = Lintian::Collect->new ($name, $type, $dir);
$name = $collect->name;
$type = $collect->type;
@@ -133,6 +133,10 @@ source, binary and udeb packages and .changes files. It creates an
object of the appropriate type and provides common functions used by the
collection interface to all types of package.
+Usually instances should not be created directly (exceptions include
+collections), but instead be requested via the
+L<info|Lintian::Lab::Entry/info> method in Lintian::Lab::Entry.
+
This module is in its infancy. Most of Lintian still reads all data from
files in the laboratory whenever that data is needed and generates that
data via collect scripts. The goal is to eventually access all data via
@@ -144,14 +148,17 @@ data in memory.
=over 4
-=item new(PACKAGE, TYPE)
+=item new(PACKAGE, TYPE, BASEDIR)
-Creates a new object appropriate to the package type. TYPE can be
-retrieved later with the type() method. Returns undef an unknown TYPE.
+Creates a new object appropriate to the package type. TYPE can be
+retrieved later with the type() method. Croaks if given an unknown
+TYPE.
PACKAGE is the name of the package and is stored in the collect object.
It can be retrieved with the name() method.
+BASEDIR is the base directory for the data and should be absolute.
+
=back
=head1 INSTANCE METHODS
diff --git a/lib/Lintian/Lab.pm b/lib/Lintian/Lab.pm
index ee793c0..21b4089 100644
--- a/lib/Lintian/Lab.pm
+++ b/lib/Lintian/Lab.pm
@@ -195,7 +195,7 @@ sub exists {
Fetches an existing package from the lab.
-The first argument can be a L<Lintian::Processable|proccessable>. In that
+The first argument can be a L<processable|Lintian::Processable>. In that
case all other arguments are ignored.
If the first calling convention is used then this method will search
diff --git a/lib/Lintian/Lab/Entry.pm b/lib/Lintian/Lab/Entry.pm
index a597e2e..b47cebb 100644
--- a/lib/Lintian/Lab/Entry.pm
+++ b/lib/Lintian/Lab/Entry.pm
@@ -156,7 +156,7 @@ sub lab_pkg {
Returns the L<Lintian::Collect|info> object associated with this entry.
-Overrides info from L<Lintian::Processable>.
+Overrides info from L<Lintian::Processable|Lintian::Processable>.
=cut
@@ -177,7 +177,7 @@ sub info {
Clears any caches held; this includes discarding the L<Lintian::Collect|info> object.
-Overrides clear_cache from L<Lintian::Processable>.
+Overrides clear_cache from L<Lintian::Processable|Lintian::Processable>.
=cut
diff --git a/lib/Lintian/Output.pm b/lib/Lintian/Output.pm
index 64b2ae4..54edf75 100644
--- a/lib/Lintian/Output.pm
+++ b/lib/Lintian/Output.pm
@@ -278,7 +278,7 @@ Print a tag. The first two arguments are hash reference with the
information about the package and the tag, $extra is the extra
information for the tag (if any) as an array reference, and $override
is either undef if the tag is not overridden or the
-L<Lintian::Tag::Override|override> for this tag. Called from
+L<override|Lintian::Tag::Override> for this tag. Called from
Lintian::Tags::tag().
=cut
@@ -375,7 +375,7 @@ sub print_end_pkg {
The following methods are only intended for subclassing and are
only available as instance methods. The methods mentioned in
-L<CLASS/INSTANCE METHODS>
+L</CLASS/INSTANCE METHODS>
usually only check whether they should do anything at all (according
to the values of verbosity_level and debug) and then call one of
the following methods to do the actual printing. Allmost all of them
@@ -507,7 +507,7 @@ tags are available:
=item :messages
-Exports all the methods in L<CLASS/INSTANCE METHODS>
+Exports all the methods in L</CLASS/INSTANCE METHODS>
=item :util
diff --git a/lib/Lintian/Processable.pm b/lib/Lintian/Processable.pm
index 907b0f2..153d240 100644
--- a/lib/Lintian/Processable.pm
+++ b/lib/Lintian/Processable.pm
@@ -44,7 +44,7 @@ Lintian::Processable -- An (abstract) object that Lintian can process
Instances of this perl class are objects that Lintian can process (e.g.
deb files). Multiple objects can then be combined into
-L<Lintain::ProcessableGroup|groups>, which Lintian will process
+L<groups|Lintain::ProcessableGroup>, which Lintian will process
together.
=head1 METHODS
@@ -108,11 +108,6 @@ Returns the name of the source package.
Returns the version of the source package.
-=item $proc->group()
-
-Returns the L<Lintain::ProcessableGroup|group> $proc is in,
-if any. If the processable is not in a group, this returns C<undef>.
-
=item $proc->tainted()
Returns a truth value if one or more fields in this Processable is
@@ -125,7 +120,7 @@ Lintian::Processable->mk_ro_accessors (qw(pkg_name pkg_version pkg_src pkg_arch
=item $proc->group([$group])
-Returns the L<Lintain::ProcessableGroup|group> $proc is in,
+Returns the L<group|Lintain::ProcessableGroup> $proc is in,
if any. If the processable is not in a group, this returns C<undef>.
Can also be used to set the group of this processable.
@@ -136,7 +131,7 @@ Lintian::Processable->mk_accessors (qw(group));
=item $proc->info
-Returns L<Lintian::Collect|$info> element for this processable.
+Returns L<$info|Lintian::Collect> element for this processable.
Note: This method must be implemented by sub-classes unless they
provide an "info" field.
diff --git a/lib/Lintian/Processable/Package.pm b/lib/Lintian/Processable/Package.pm
index 169f389..1484f39 100644
--- a/lib/Lintian/Processable/Package.pm
+++ b/lib/Lintian/Processable/Package.pm
@@ -48,7 +48,7 @@ Lintian::Processable::Package -- An object that Lintian can process
Instances of this perl class are objects that Lintian can process (e.g.
deb files). Multiple objects can then be combined into
-L<Lintain::ProcessableGroup|groups>, which Lintian will process
+L<groups|Lintian::ProcessableGroup>, which Lintian will process
together.
=head1 METHODS
@@ -65,7 +65,7 @@ defines this type of processable (e.g. the changes file).
=item $proc->lab_pkg([$lpkg])
-Returns or sets the L<Lab::Package|$info> element for this processable.
+Returns or sets the L<$lpkg|Lintian::Lab::Entry> element for this processable.
=cut
diff --git a/lib/Lintian/ProcessableGroup.pm b/lib/Lintian/ProcessableGroup.pm
index 5fe3199..eef753f 100644
--- a/lib/Lintian/ProcessableGroup.pm
+++ b/lib/Lintian/ProcessableGroup.pm
@@ -44,7 +44,7 @@ Lintian::ProcessableGroup -- A group of objects that Lintian can process
=head1 DESCRIPTION
Instances of this perl class are sets of
-L<Lintian::Processable|processables>. It allows at most one source
+L<processables|Lintian::Processable>. It allows at most one source
and one changes package per set, but multiple binary packages
(provided that the binary is not already in the set).
@@ -296,7 +296,7 @@ sub get_binary_processables {
=item $group->info
-Returns L<Lintian::Collect::Group|$info> element for this group.
+Returns L<$info|Lintian::Collect::Group> element for this group.
=cut
diff --git a/lib/Lintian/ProcessablePool.pm b/lib/Lintian/ProcessablePool.pm
index c0c8c90..e5f5c82 100644
--- a/lib/Lintian/ProcessablePool.pm
+++ b/lib/Lintian/ProcessablePool.pm
@@ -67,8 +67,8 @@ sub new {
=item $pool->add_file($file)
-Adds a file to the pool. The $file will be turned into
-a L<Lintian::Processable> and grouped together with other
+Adds a file to the pool. The $file will be turned into a
+L<processable|Lintian::Processable> and grouped together with other
processables from the same source package (if any).
=cut
@@ -97,7 +97,7 @@ sub add_file {
=item $pool->add_proc ($proc)
-Adds a L<Lintian::Processable|processable> to the pool.
+Adds a L<processable|Lintian::Processable> to the pool.
=cut
--
Debian package checker
Reply to: