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.

debian/changelog

@@ -24,6 +24,7 @@ dpkg (1.17.17) UNRELEASED; urgency=low
     - Document public module Dpkg.
     - Document public module Dpkg::Gettext.
     - Mark Dpkg::BuildProfiles as a public module.
+    - Document all public module versions in a CHANGES section.
   * Set the DEB_TARGET_* dpkg-architecture variables from architecture.mk.
     Missed in dpkg 1.17.14.
   * Initialize DEB_TARGET_ARCH variable without requiring DEB_HOST_ARCH,

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>

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>

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>

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>

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>.

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>.

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;

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>.

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>.

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>

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>.

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>.

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>.

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>.

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>.

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>.

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>.

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>.

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>.

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;

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;

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

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>.

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>.

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>.

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>

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>.

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;

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