summaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2014-10-11 15:58:15 +0200
committerGuillem Jover <guillem@debian.org>2014-10-12 06:34:36 +0200
commit8d886702ff54efcd19dcf674cb92ea125a4822ca (patch)
tree8e62d8ee103d72af759b9b52a8f41a55c84f565b /scripts
parent1b7cbd6176575f926526b380475e9f055121e01e (diff)
downloaddpkg-8d886702ff54efcd19dcf674cb92ea125a4822ca.tar.gz
scripts: Document all public module versions in a CHANGES section
This makes it clear what is the current version of the module, and that it is a public interface.
Diffstat (limited to 'scripts')
-rw-r--r--scripts/Dpkg/BuildFlags.pm4
-rw-r--r--scripts/Dpkg/BuildOptions.pm4
-rw-r--r--scripts/Dpkg/Changelog.pm6
-rw-r--r--scripts/Dpkg/Changelog/Debian.pm6
-rw-r--r--scripts/Dpkg/Changelog/Entry.pm6
-rw-r--r--scripts/Dpkg/Changelog/Entry/Debian.pm4
-rw-r--r--scripts/Dpkg/Changelog/Parse.pm6
-rw-r--r--scripts/Dpkg/Checksums.pm4
-rw-r--r--scripts/Dpkg/Compression.pm4
-rw-r--r--scripts/Dpkg/Compression/FileHandle.pm4
-rw-r--r--scripts/Dpkg/Compression/Process.pm6
-rw-r--r--scripts/Dpkg/Conf.pm4
-rw-r--r--scripts/Dpkg/Control.pm6
-rw-r--r--scripts/Dpkg/Control/Changelog.pm6
-rw-r--r--scripts/Dpkg/Control/Fields.pm6
-rw-r--r--scripts/Dpkg/Control/FieldsCore.pm6
-rw-r--r--scripts/Dpkg/Control/Hash.pm6
-rw-r--r--scripts/Dpkg/Control/HashCore.pm4
-rw-r--r--scripts/Dpkg/Control/Info.pm6
-rw-r--r--scripts/Dpkg/Deps.pm4
-rw-r--r--scripts/Dpkg/Exit.pm4
-rw-r--r--scripts/Dpkg/IPC.pm4
-rw-r--r--scripts/Dpkg/Index.pm6
-rw-r--r--scripts/Dpkg/Interface/Storable.pm6
-rw-r--r--scripts/Dpkg/Path.pm4
-rw-r--r--scripts/Dpkg/Source/Package.pm4
-rw-r--r--scripts/Dpkg/Substvars.pm4
-rw-r--r--scripts/Dpkg/Vendor.pm4
-rw-r--r--scripts/Dpkg/Version.pm4
29 files changed, 142 insertions, 0 deletions
diff --git a/scripts/Dpkg/BuildFlags.pm b/scripts/Dpkg/BuildFlags.pm
index 444e4e71a..d92feede8 100644
--- a/scripts/Dpkg/BuildFlags.pm
+++ b/scripts/Dpkg/BuildFlags.pm
@@ -458,6 +458,10 @@ the prepend operation everywhere.
New method: $bf->load_maintainer_config() that update the build flags
based on the package maintainer directives.
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>
diff --git a/scripts/Dpkg/BuildOptions.pm b/scripts/Dpkg/BuildOptions.pm
index a7282e06b..6816ffc5d 100644
--- a/scripts/Dpkg/BuildOptions.pm
+++ b/scripts/Dpkg/BuildOptions.pm
@@ -195,6 +195,10 @@ sub export {
Enable to use another environment variable instead of DEB_BUILD_OPTIONS.
Thus add support for the "envvar" option at creation time.
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>
diff --git a/scripts/Dpkg/Changelog.pm b/scripts/Dpkg/Changelog.pm
index 1745e6f46..054d82bba 100644
--- a/scripts/Dpkg/Changelog.pm
+++ b/scripts/Dpkg/Changelog.pm
@@ -694,6 +694,12 @@ Any combination of one option of C<since> and C<from> and one of
C<until> and C<to> returns the intersection of the two results
with only one of the options specified.
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Frank Lichtenheld, E<lt>frank@lichtenheld.deE<gt>
diff --git a/scripts/Dpkg/Changelog/Debian.pm b/scripts/Dpkg/Changelog/Debian.pm
index 707c621fb..ce13d9618 100644
--- a/scripts/Dpkg/Changelog/Debian.pm
+++ b/scripts/Dpkg/Changelog/Debian.pm
@@ -201,6 +201,12 @@ Dpkg::Changelog
Description of the Debian changelog format in the Debian policy:
L<https://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog>.
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHORS
Frank Lichtenheld, E<lt>frank@lichtenheld.deE<gt>
diff --git a/scripts/Dpkg/Changelog/Entry.pm b/scripts/Dpkg/Changelog/Entry.pm
index 6a25da778..a4d5770cd 100644
--- a/scripts/Dpkg/Changelog/Entry.pm
+++ b/scripts/Dpkg/Changelog/Entry.pm
@@ -297,6 +297,12 @@ sub get_dpkg_changes {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Changelog/Entry/Debian.pm b/scripts/Dpkg/Changelog/Entry/Debian.pm
index ef4b71661..956217256 100644
--- a/scripts/Dpkg/Changelog/Entry/Debian.pm
+++ b/scripts/Dpkg/Changelog/Entry/Debian.pm
@@ -315,6 +315,10 @@ New functions: match_header(), match_trailer()
Deprecated variables: $regex_header, $regex_trailer
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Changelog/Parse.pm b/scripts/Dpkg/Changelog/Parse.pm
index d6429b7e6..6e5e7a0b9 100644
--- a/scripts/Dpkg/Changelog/Parse.pm
+++ b/scripts/Dpkg/Changelog/Parse.pm
@@ -162,6 +162,12 @@ sub changelog_parse {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=cut
1;
diff --git a/scripts/Dpkg/Checksums.pm b/scripts/Dpkg/Checksums.pm
index 854434941..abcbea49d 100644
--- a/scripts/Dpkg/Checksums.pm
+++ b/scripts/Dpkg/Checksums.pm
@@ -383,6 +383,10 @@ New argument: Accept an options argument in $ck->export_to_string().
New option: Accept new option 'update' in $ck->add_from_file() and
$ck->add_from_control().
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Compression.pm b/scripts/Dpkg/Compression.pm
index 27dfbdfe1..b7bc8e3ab 100644
--- a/scripts/Dpkg/Compression.pm
+++ b/scripts/Dpkg/Compression.pm
@@ -237,6 +237,10 @@ and $compression_re_file_ext
Default compression level is not global any more, it is per compressor type.
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Compression/FileHandle.pm b/scripts/Dpkg/Compression/FileHandle.pm
index aa12f25e7..e3a07a4da 100644
--- a/scripts/Dpkg/Compression/FileHandle.pm
+++ b/scripts/Dpkg/Compression/FileHandle.pm
@@ -462,6 +462,10 @@ C<*$self->{...}> to access the associated hash like in the example below:
New argument: $fh->ensure_open() accepts an %opts argument.
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>
diff --git a/scripts/Dpkg/Compression/Process.pm b/scripts/Dpkg/Compression/Process.pm
index bb791f337..ff5c8f0fe 100644
--- a/scripts/Dpkg/Compression/Process.pm
+++ b/scripts/Dpkg/Compression/Process.pm
@@ -200,6 +200,12 @@ sub wait_end_process {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Conf.pm b/scripts/Dpkg/Conf.pm
index 53862650a..ea4f6ef05 100644
--- a/scripts/Dpkg/Conf.pm
+++ b/scripts/Dpkg/Conf.pm
@@ -184,6 +184,10 @@ sub output {
New method: $conf->filter()
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control.pm b/scripts/Dpkg/Control.pm
index fae49d924..6989b60c7 100644
--- a/scripts/Dpkg/Control.pm
+++ b/scripts/Dpkg/Control.pm
@@ -191,6 +191,12 @@ sub get_type {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/Changelog.pm b/scripts/Dpkg/Control/Changelog.pm
index a6890ea5e..850bdc72f 100644
--- a/scripts/Dpkg/Control/Changelog.pm
+++ b/scripts/Dpkg/Control/Changelog.pm
@@ -53,6 +53,12 @@ sub new {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/Fields.pm b/scripts/Dpkg/Control/Fields.pm
index bc1754628..6f2eee4e3 100644
--- a/scripts/Dpkg/Control/Fields.pm
+++ b/scripts/Dpkg/Control/Fields.pm
@@ -56,6 +56,12 @@ with associated meta-data explaining in which type of control information
they are allowed. The vendor-neutral fieldnames and all functions are
inherited from Dpkg::Control::FieldsCore.
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/FieldsCore.pm b/scripts/Dpkg/Control/FieldsCore.pm
index 2b7434dc3..8a5695b20 100644
--- a/scripts/Dpkg/Control/FieldsCore.pm
+++ b/scripts/Dpkg/Control/FieldsCore.pm
@@ -662,6 +662,12 @@ sub field_insert_before($$@) {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/Hash.pm b/scripts/Dpkg/Control/Hash.pm
index 85eccaccd..277b36126 100644
--- a/scripts/Dpkg/Control/Hash.pm
+++ b/scripts/Dpkg/Control/Hash.pm
@@ -37,6 +37,12 @@ Dpkg::Control::Hash - parse and manipulate a block of RFC822-like fields
This module is just like Dpkg::Control::HashCore, with vendor-specific
field knowledge.
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/HashCore.pm b/scripts/Dpkg/Control/HashCore.pm
index 67b264a48..23d7fd010 100644
--- a/scripts/Dpkg/Control/HashCore.pm
+++ b/scripts/Dpkg/Control/HashCore.pm
@@ -539,6 +539,10 @@ sub NEXTKEY {
New method: $c->parse_error().
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Control/Info.pm b/scripts/Dpkg/Control/Info.pm
index 17c5b8929..f066161a2 100644
--- a/scripts/Dpkg/Control/Info.pm
+++ b/scripts/Dpkg/Control/Info.pm
@@ -200,6 +200,12 @@ information.
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Deps.pm b/scripts/Dpkg/Deps.pm
index 8e7468c37..5e9728bc9 100644
--- a/scripts/Dpkg/Deps.pm
+++ b/scripts/Dpkg/Deps.pm
@@ -1513,6 +1513,10 @@ supplementary parameters ($arch and $multiarch).
Deprecated method: Dpkg::Deps::KnownFacts->check_package() is obsolete,
it should not have been part of the public API.
+=head2 Version 1.00
+
+Mark the module as public.
+
=cut
1;
diff --git a/scripts/Dpkg/Exit.pm b/scripts/Dpkg/Exit.pm
index f973c3570..2c6b06895 100644
--- a/scripts/Dpkg/Exit.pm
+++ b/scripts/Dpkg/Exit.pm
@@ -94,6 +94,10 @@ New functions: push_exit_handler(), pop_exit_handler(), run_exit_handlers()
Deprecated variable: @handlers
+=head2 Version 1.00
+
+Mark the module as public.
+
=cut
1;
diff --git a/scripts/Dpkg/IPC.pm b/scripts/Dpkg/IPC.pm
index 1c73a59fc..6eab6328e 100644
--- a/scripts/Dpkg/IPC.pm
+++ b/scripts/Dpkg/IPC.pm
@@ -401,6 +401,10 @@ __END__
New options: spawn() now accepts 'sig' and 'delete_sig'.
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHORS
Written by Raphaël Hertzog <hertzog@debian.org> and
diff --git a/scripts/Dpkg/Index.pm b/scripts/Dpkg/Index.pm
index 67f4773f1..4db19a6b3 100644
--- a/scripts/Dpkg/Index.pm
+++ b/scripts/Dpkg/Index.pm
@@ -342,6 +342,12 @@ sub output {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Interface/Storable.pm b/scripts/Dpkg/Interface/Storable.pm
index adef210fc..fe31e3dc3 100644
--- a/scripts/Dpkg/Interface/Storable.pm
+++ b/scripts/Dpkg/Interface/Storable.pm
@@ -138,6 +138,12 @@ sub _stringify {
=back
+=head1 CHANGES
+
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Path.pm b/scripts/Dpkg/Path.pm
index 6647f34e4..d6dda5787 100644
--- a/scripts/Dpkg/Path.pm
+++ b/scripts/Dpkg/Path.pm
@@ -291,6 +291,10 @@ New function: get_control_path()
New function: find_command()
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Source/Package.pm b/scripts/Dpkg/Source/Package.pm
index 37e56195e..fc5cc2f50 100644
--- a/scripts/Dpkg/Source/Package.pm
+++ b/scripts/Dpkg/Source/Package.pm
@@ -630,6 +630,10 @@ get_default_tar_ignore_pattern()
Deprecated variables: $diff_ignore_default_regexp, @tar_ignore_default_pattern
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog, E<lt>hertzog@debian.orgE<gt>
diff --git a/scripts/Dpkg/Substvars.pm b/scripts/Dpkg/Substvars.pm
index 2a6aace39..81bd258bf 100644
--- a/scripts/Dpkg/Substvars.pm
+++ b/scripts/Dpkg/Substvars.pm
@@ -385,6 +385,10 @@ Deprecated method: $s->no_warn(), use $s->mark_as_used() instead.
New method: $s->set_as_used().
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Raphaël Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Vendor.pm b/scripts/Dpkg/Vendor.pm
index 43b50d3c1..fb3faa145 100644
--- a/scripts/Dpkg/Vendor.pm
+++ b/scripts/Dpkg/Vendor.pm
@@ -188,6 +188,10 @@ sub run_vendor_hook {
New function: get_vendor_dir().
+=head2 Version 1.00
+
+Mark the module as public.
+
=cut
1;
diff --git a/scripts/Dpkg/Version.pm b/scripts/Dpkg/Version.pm
index e50e1f510..49fb9f6b6 100644
--- a/scripts/Dpkg/Version.pm
+++ b/scripts/Dpkg/Version.pm
@@ -436,6 +436,10 @@ New argument: Accept an options argument in $v->as_string().
New method: $v->is_native().
+=head2 Version 1.00
+
+Mark the module as public.
+
=head1 AUTHOR
Don Armstrong <don@donarmstrong.com>, Colin Watson