summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2014-05-15 06:22:33 +0200
committerGuillem Jover <guillem@debian.org>2014-05-17 13:30:54 +0200
commita5b5f737990633e52fc9eea7684f9884bec6924b (patch)
treeade7189b3f6cb80b8ce694421bc7816cb1da8140
parentad75cd9bdfb0a6322425206ab70882ad7d832125 (diff)
downloaddpkg-a5b5f737990633e52fc9eea7684f9884bec6924b.tar.gz
Dpkg: Update and fix CHANGES POD sections
Do not use actual POD =item, just normal paragraphs. Split items in different paragraphs. Sort versions in decreasing order. Document missing changes in public interfaces. Qualify methods with the variable.
-rw-r--r--debian/changelog1
-rw-r--r--scripts/Dpkg/BuildFlags.pm20
-rw-r--r--scripts/Dpkg/Changelog/Entry/Debian.pm1
-rw-r--r--scripts/Dpkg/Conf.pm6
-rw-r--r--scripts/Dpkg/Control/HashCore.pm2
-rw-r--r--scripts/Dpkg/Deps.pm22
-rw-r--r--scripts/Dpkg/Exit.pm1
-rw-r--r--scripts/Dpkg/Substvars.pm15
8 files changed, 42 insertions, 26 deletions
diff --git a/debian/changelog b/debian/changelog
index e5dd0f82b..17646f331 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -38,6 +38,7 @@ dpkg (1.17.10) UNRELEASED; urgency=low
* Perl modules:
- Bump $VERSION for Dpkg::Patch, missed in 1.16.1.
- Bump $VERSION for Dpkg::Deps, missed in 1.17.0.
+ - Update and fix CHANGES POD sections for public modules.
[ Updated manpages translations ]
* German (Helge Kreutzmann).
diff --git a/scripts/Dpkg/BuildFlags.pm b/scripts/Dpkg/BuildFlags.pm
index 50eb7a21a..bd8a3fd0f 100644
--- a/scripts/Dpkg/BuildFlags.pm
+++ b/scripts/Dpkg/BuildFlags.pm
@@ -438,25 +438,25 @@ sub list {
=head1 CHANGES
-=head2 Version 1.01
+=head2 Version 1.03
-New method: $bf->prepend() very similar to append(). Implement support of
-the prepend operation everywhere.
+New method: $bf->get_feature_areas() to list possible values for
+$bf->get_features.
-New method: $bf->load_maintainer_config() that update the build flags
-based on the package maintainer directives.
+New method $bf->is_maintainer_modified() and new optional parameter to
+$bf->set(), $bf->append(), $bf->prepend(), $bf->strip().
=head2 Version 1.02
New methods: $bf->get_features(), $bf->has_features(), $bf->set_feature().
-=head2 Version 1.03
+=head2 Version 1.01
-New method: $bf->get_feature_areas() to list possible values for
-$bf->get_features.
+New method: $bf->prepend() very similar to append(). Implement support of
+the prepend operation everywhere.
-New method $bf->is_maintainer_modified() and new optional parameter to
-$bf->set(), $bf->append(), $bf->prepend(), $bf->strip().
+New method: $bf->load_maintainer_config() that update the build flags
+based on the package maintainer directives.
=head1 AUTHOR
diff --git a/scripts/Dpkg/Changelog/Entry/Debian.pm b/scripts/Dpkg/Changelog/Entry/Debian.pm
index 4ad43ebd4..ef4b71661 100644
--- a/scripts/Dpkg/Changelog/Entry/Debian.pm
+++ b/scripts/Dpkg/Changelog/Entry/Debian.pm
@@ -312,6 +312,7 @@ sub find_closes {
=head2 Version 1.01
New functions: match_header(), match_trailer()
+
Deprecated variables: $regex_header, $regex_trailer
=head1 AUTHOR
diff --git a/scripts/Dpkg/Conf.pm b/scripts/Dpkg/Conf.pm
index 2f9ef6730..0716f222c 100644
--- a/scripts/Dpkg/Conf.pm
+++ b/scripts/Dpkg/Conf.pm
@@ -177,6 +177,12 @@ sub output {
=back
+=head1 CHANGES
+
+=head2 Version 1.01
+
+New method: $conf->filter()
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/HashCore.pm b/scripts/Dpkg/Control/HashCore.pm
index dfd5e5531..af41c7e90 100644
--- a/scripts/Dpkg/Control/HashCore.pm
+++ b/scripts/Dpkg/Control/HashCore.pm
@@ -534,7 +534,7 @@ sub NEXTKEY {
=head2 Version 1.01
-New method: parse_error().
+New method: $c->parse_error().
=head1 AUTHOR
diff --git a/scripts/Dpkg/Deps.pm b/scripts/Dpkg/Deps.pm
index f140fdad4..c7bc265a6 100644
--- a/scripts/Dpkg/Deps.pm
+++ b/scripts/Dpkg/Deps.pm
@@ -1446,28 +1446,20 @@ New option: Add build_arch option to Dpkg::Deps::deps_parse().
=head2 Version 1.02
-=over
-
-=item * Add new Dpkg::deps_concat() function.
-
-=back
+New function: Dpkg::Deps::deps_concat()
=head2 Version 1.01
-=over
+New method: Add $dep->reset() for all dependency objects.
-=item * Add new $dep->reset() method that all dependency objects support.
+New property: Dpkg::Deps::Simple now recognizes the arch qualifier "any"
+and stores it in the "archqual" property when present.
-=item * Dpkg::Deps::Simple now recognizes the arch qualifier "any" and
-stores it in the "archqual" property when present.
-
-=item * Dpkg::Deps::KnownFacts->add_installed_package() now accepts 2
+New option: Dpkg::Deps::KnownFacts->add_installed_package() now accepts 2
supplementary parameters ($arch and $multiarch).
-=item * Dpkg::Deps::KnownFacts->check_package() is obsolete, it should
-not have been part of the public API.
-
-=back
+Deprecated method: Dpkg::Deps::KnownFacts->check_package() is obsolete,
+it should not have been part of the public API.
=cut
diff --git a/scripts/Dpkg/Exit.pm b/scripts/Dpkg/Exit.pm
index b967f42f5..f973c3570 100644
--- a/scripts/Dpkg/Exit.pm
+++ b/scripts/Dpkg/Exit.pm
@@ -91,6 +91,7 @@ $SIG{QUIT} = \&exit_handler;
=head2 Version 1.01
New functions: push_exit_handler(), pop_exit_handler(), run_exit_handlers()
+
Deprecated variable: @handlers
=cut
diff --git a/scripts/Dpkg/Substvars.pm b/scripts/Dpkg/Substvars.pm
index e07fa323b..5e1b2a7fe 100644
--- a/scripts/Dpkg/Substvars.pm
+++ b/scripts/Dpkg/Substvars.pm
@@ -330,6 +330,21 @@ sub output {
=back
+=head1 CHANGES
+
+=head2 Version 1.02
+
+New argument: Accept a $binaryversion in $s->set_version_substvars(),
+passing a single argument is still supported.
+
+New method: $s->mark_as_used().
+
+Deprecated method: $s->no_warn(), use $s->mark_as_used() instead.
+
+=head2 Version 1.01
+
+New method: $s->set_as_used().
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.