The following commit has been merged in the master branch: commit 4a0c79171400847ea97ebd66384fde21f497964c Author: Guillem Jover <guil...@debian.org> Date: Sun May 10 18:33:09 2009 +0200
Fix POD errors detected by podchecker in perl modules Add missing blank lines after =cut, close =over section with =back and add a FIXME comment to an empty section. diff --git a/scripts/Dpkg/Cdata.pm b/scripts/Dpkg/Cdata.pm index a8294bd..48b7099 100644 --- a/scripts/Dpkg/Cdata.pm +++ b/scripts/Dpkg/Cdata.pm @@ -52,6 +52,7 @@ The return value is a reference to a tied hash (Dpkg::Fields::Object) that can be used to access the various fields. =cut + sub parsecdata { my ($input, $file, %options) = @_; @@ -121,4 +122,5 @@ sub parsecdata { =back =cut + 1; diff --git a/scripts/Dpkg/Changelog.pm b/scripts/Dpkg/Changelog.pm index 5a91632..ee2a9fc 100644 --- a/scripts/Dpkg/Changelog.pm +++ b/scripts/Dpkg/Changelog.pm @@ -24,7 +24,7 @@ Dpkg::Changelog =head1 DESCRIPTION -to be written +FIXME: to be written =head2 Functions @@ -722,6 +722,7 @@ as "--<key>". If the value of the corresponding hash entry is defined, then it's passed as the parameter that follows. =cut + sub parse_changelog { my (%options) = @_; my @parserpath = ("/usr/local/lib/dpkg/parsechangelog", @@ -821,6 +822,8 @@ Dpkg::Changelog::Entry - represents one entry in a Debian changelog =head1 SYNOPSIS +FIXME: to be written + =head1 DESCRIPTION =cut diff --git a/scripts/Dpkg/Control.pm b/scripts/Dpkg/Control.pm index 6e4ab85..0dfacca 100644 --- a/scripts/Dpkg/Control.pm +++ b/scripts/Dpkg/Control.pm @@ -42,6 +42,7 @@ Create a new Dpkg::Control object for $file. If $file is omitted, it parses debian/control. If file is "-", it parses the standard input. =cut + sub new { my ($this, $arg) = @_; my $class = ref($this) || $this; @@ -67,6 +68,7 @@ sub new { Resets what got read. =cut + sub reset { my $self = shift; $self->{source} = undef; @@ -78,6 +80,7 @@ sub reset { Parse the content of $file. Exits in case of errors. =cut + sub parse { my ($self, $file) = @_; open(CDATA, "<", $file) || syserr(_g("cannot read %s"), $file); @@ -93,6 +96,7 @@ or a description of where the data comes from. It's used in error messages. =cut + sub parse_fh { my ($self, $fh, $desc) = @_; $self->reset(); @@ -118,6 +122,7 @@ Returns a reference to a hash containing the fields concerning the source package. The hash is tied to Dpkg::Fields::Object. =cut + sub get_source { my $self = shift; return $self->{source}; @@ -130,6 +135,7 @@ package numbered $idx (starting at 1). The hash is tied to Dpkg::Fields::Object. =cut + sub get_pkg_by_idx { my ($self, $idx) = @_; return $self->{packages}[--$idx]; @@ -141,6 +147,7 @@ Returns a reference to a hash containing the fields concerning the binary package named $name. The hash is tied to Dpkg::Fields::Object. =cut + sub get_pkg_by_name { my ($self, $name) = @_; foreach my $pkg (@{$self->{packages}}) { @@ -155,6 +162,7 @@ sub get_pkg_by_name { Returns a list containing the hashes for all binary packages. =cut + sub get_packages { my $self = shift; return @{$self->{packages}}; @@ -165,6 +173,7 @@ sub get_packages { Dump the content into a filehandle. =cut + sub dump { my ($self, $fh) = @_; tied(%{$self->{source}})->dump($fh); diff --git a/scripts/Dpkg/Deps.pm b/scripts/Dpkg/Deps.pm index 540ffca..89a1e10 100644 --- a/scripts/Dpkg/Deps.pm +++ b/scripts/Dpkg/Deps.pm @@ -116,6 +116,7 @@ The arguments can also be undef in case there's no explicit architecture restriction. =cut + sub arch_is_superset { my ($p, $q) = @_; my $p_arch_neg = defined($p) && $p->[0] =~ /^!/; @@ -186,6 +187,7 @@ dependency. It returns 0 if the "p" dependency implies that "q" is not satisfied. It returns undef when there's no implication. =cut + sub version_implies { my ($rel_p, $v_p, $rel_q, $v_q) = @_; @@ -296,6 +298,7 @@ this when parsing non-dependency fields like Conflicts (see =back =cut + sub parse { my $dep_line = shift; my %options = (@_); @@ -357,6 +360,7 @@ dumping. =back =cut + sub compare { my ($a, $b) = @_; return -1 if $a->is_empty(); @@ -785,6 +789,7 @@ Add a new dependency object at the end of the list. =back =cut + use strict; use warnings; @@ -1113,6 +1118,7 @@ packages provided (by the set of installed packages). Create a new object. =cut + use strict; use warnings; @@ -1131,6 +1137,7 @@ undefined we know that the package is installed but we don't know which version it is. =cut + sub add_installed_package { my ($self, $pkg, $ver) = @_; $self->{pkg}{$pkg} = $ver; @@ -1143,6 +1150,7 @@ and $version correspond to the associated relation given in the Provides field. This might be used in the future for versioned provides. =cut + sub add_provided_package { my ($self, $pkg, $rel, $ver, $by) = @_; if (not exists $self->{virtualpkg}{$pkg}) { @@ -1161,6 +1169,7 @@ listed as [ $provider, $relation, $version ]). =back =cut + sub check_package { my ($self, $pkg) = @_; if (exists $self->{pkg}{$pkg}) { diff --git a/scripts/Dpkg/Fields.pm b/scripts/Dpkg/Fields.pm index 5cb090b..fea5dc4 100644 --- a/scripts/Dpkg/Fields.pm +++ b/scripts/Dpkg/Fields.pm @@ -46,6 +46,7 @@ Dpkg::Fields::capit). It also stores the order in which fields have been added in order to be able to dump them in the same order. =cut + use Tie::Hash; our @ISA = qw(Tie::ExtraHash Tie::Hash); @@ -66,6 +67,7 @@ Return a reference to a tied hash implementing storage of simple "field: value" mapping as used in many Debian-specific files. =cut + sub new { my $hash = {}; tie %{$hash}, 'Dpkg::Fields::Object'; @@ -138,6 +140,7 @@ following regex: /X[SBC]+-$name/i. Return the name of the field found or undef if nothing has been found. =cut + sub find_custom_field { my ($self, $name) = @_; foreach my $key (keys %{$self->[0]}) { @@ -151,6 +154,7 @@ sub find_custom_field { Identify a user field and retrieve its value. =cut + sub get_custom_field { my ($self, $name) = @_; my $key = $self->find_custom_field($name); @@ -164,6 +168,7 @@ sub get_custom_field { Dump the raw content of the hash either as a string or to a filehandle. =cut + sub dump { my ($self, $fh) = @_; my $str = ""; @@ -181,6 +186,7 @@ sub dump { Define the order in which fields will be displayed in the output() method. =cut + sub set_field_importance { my ($self, @fields) = @_; my $i = 1; @@ -197,6 +203,7 @@ substitution of variables defined in the Dpkg::Substvars object. Also returns the string of what would printed on the filehandle. =cut + sub output { my ($self, $fh, $substvars) = @_; my $str = ""; diff --git a/scripts/Dpkg/Path.pm b/scripts/Dpkg/Path.pm index 507a1f0..18b59b4 100644 --- a/scripts/Dpkg/Path.pm +++ b/scripts/Dpkg/Path.pm @@ -88,6 +88,7 @@ It can still return undef if a file outside of the debian sub-directory is provided. =cut + sub guess_pkg_root_dir($) { my $file = shift; my $root = get_pkg_root_dir($file); @@ -113,6 +114,7 @@ numbers and the inode numbers returned by stat()/lstat() are the same. If $resolve_symlink is true then stat() is used, otherwise lstat() is used. =cut + sub check_files_are_the_same($$;$) { my ($file1, $file2, $resolve_symlink) = @_; return 0 if ((! -e $file1) || (! -e $file2)); @@ -137,6 +139,7 @@ previous element is not a symlink. Thus it should only be used on real filenames. =cut + sub canonpath($) { my $path = shift; $path = File::Spec->canonpath($path); @@ -170,6 +173,7 @@ Return the filename of the file pointed by the symlink. The new name is canonicalized by canonpath(). =cut + sub resolve_symlink($) { my $symlink = shift; my $content = readlink($symlink); diff --git a/scripts/Dpkg/Substvars.pm b/scripts/Dpkg/Substvars.pm index 136612e..c3601f2 100644 --- a/scripts/Dpkg/Substvars.pm +++ b/scripts/Dpkg/Substvars.pm @@ -51,6 +51,7 @@ and ${dpkg:Upstream-Version}. Additional substitutions will be read from the $file passed as parameter. =cut + sub new { my ($this, $arg) = @_; my $class = ref($this) || $this; @@ -74,6 +75,7 @@ sub new { Add/replace a substitution. =cut + sub set { my ($self, $key, $value) = @_; $self->{$key} = $value; @@ -84,6 +86,7 @@ sub set { Get the value of a given substitution. =cut + sub get { my ($self, $key) = @_; return $self->{$key}; @@ -94,6 +97,7 @@ sub get { Remove a given substitution. =cut + sub delete { my ($self, $key) = @_; return delete $self->{$key}; @@ -104,6 +108,7 @@ sub delete { Add new substitutions read from $file. =cut + sub parse { my ($self, $varlistfile) = @_; $varlistfile="./$varlistfile" if $varlistfile =~ m/\s/; @@ -129,6 +134,7 @@ Defines ${binary:Version}, ${source:Version} and ${source:Upstream-Version} based on the given version string. =cut + sub set_version_substvars { my ($self, $version) = @_; @@ -159,6 +165,7 @@ sub set_arch_substvars { Substitutes variables in $string and return the result in $newstring. =cut + sub substvars { my ($self, $v) = @_; my $lhs; diff --git a/scripts/Dpkg/Vendor.pm b/scripts/Dpkg/Vendor.pm index e30de3c..f0062fa 100644 --- a/scripts/Dpkg/Vendor.pm +++ b/scripts/Dpkg/Vendor.pm @@ -57,6 +57,7 @@ to the vendor of the currently installed operating system. Returns undef if there's no file for the given vendor. =cut + sub get_vendor_info(;$) { my $vendor = shift || "default"; my $file = get_vendor_file($vendor); @@ -73,6 +74,7 @@ Check if there's a file for the given vendor and returns its name. =cut + sub get_vendor_file(;$) { my $vendor = shift || "default"; my $file; @@ -89,6 +91,7 @@ that first, otherwise it falls back to parsing /etc/dpkg/origins/default. If that file doesn't exist, it returns undef. =cut + sub get_current_vendor() { my $f; if ($ENV{'DEB_VENDOR'}) { @@ -108,6 +111,7 @@ If no vendor can be identified, then return the Dpkg::Vendor::Default object. =cut + my %OBJECT_CACHE; sub get_vendor_object { my $vendor = shift || get_current_vendor() || "Default"; @@ -133,9 +137,14 @@ sub get_vendor_object { Run a hook implemented by the current vendor object. =cut + sub run_vendor_hook { my $vendor_obj = get_vendor_object(); $vendor_obj->run_hook(@_); } +=back + +=cut + 1; diff --git a/scripts/Dpkg/Vendor/Default.pm b/scripts/Dpkg/Vendor/Default.pm index 0295aeb..43d40cd 100644 --- a/scripts/Dpkg/Vendor/Default.pm +++ b/scripts/Dpkg/Vendor/Default.pm @@ -52,6 +52,7 @@ Creates the default vendor object. Can be inherited by all vendor objects if they don't need any specific initialization at object creation time. =cut + sub new { my ($this) = @_; my $class = ref($this) || $this; @@ -87,6 +88,7 @@ vendor-specific keyrings. =back =cut + sub run_hook { my ($self, $hook, @params) = @_; @@ -102,4 +104,5 @@ sub run_hook { =back =cut + 1; diff --git a/scripts/Dpkg/Vendor/Ubuntu.pm b/scripts/Dpkg/Vendor/Ubuntu.pm index 28e94b7..2f31a8b 100644 --- a/scripts/Dpkg/Vendor/Ubuntu.pm +++ b/scripts/Dpkg/Vendor/Ubuntu.pm @@ -36,6 +36,7 @@ This vendor object customize the behaviour of dpkg-source to check that Maintainers have been modified if necessary. =cut + sub run_hook { my ($self, $hook, @params) = @_; @@ -87,6 +88,7 @@ which are references to bugs on Launchpad. Returns all closed bug numbers in an array reference. =cut + sub find_launchpad_closes { my ($changes) = @_; my @closes = (); @@ -104,4 +106,5 @@ sub find_launchpad_closes { =back =cut + 1; diff --git a/scripts/Dpkg/Version.pm b/scripts/Dpkg/Version.pm index a7ad1c3..e4afab5 100644 --- a/scripts/Dpkg/Version.pm +++ b/scripts/Dpkg/Version.pm @@ -202,6 +202,7 @@ an error message if it contains illegal characters, otherwise it returns true. =cut + sub check_version ($;$) { my ($version, $die) = @_; $version ||= ""; -- dpkg's main repository -- To UNSUBSCRIBE, email to debian-dpkg-cvs-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org