This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch main in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=024834e3729322f7233e580231d126634adf8899 commit 024834e3729322f7233e580231d126634adf8899 Author: Guillem Jover <[email protected]> AuthorDate: Tue Feb 28 03:45:18 2023 +0100 perl: Add POD to all private modules Mark them explicitly as private modules, add some minimal description for their purpose. This also fixes the warnings from pod2man where it cannot generate a man page for these. Closes: #1030660 --- dselect/methods/Dselect/Ftp.pm | 22 ++++++++++++++ scripts/Dpkg/BuildEnv.pm | 2 ++ scripts/Dpkg/BuildTypes.pm | 2 ++ scripts/Dpkg/Control/HashCore/Tie.pm | 50 +++++++++++++++++++++++++------- scripts/Dpkg/Control/Types.pm | 2 ++ scripts/Dpkg/Dist/Files.pm | 23 +++++++++++++++ scripts/Dpkg/ErrorHandling.pm | 22 ++++++++++++++ scripts/Dpkg/File.pm | 22 ++++++++++++++ scripts/Dpkg/Getopt.pm | 23 +++++++++++++++ scripts/Dpkg/Lock.pm | 22 ++++++++++++++ scripts/Dpkg/OpenPGP.pm | 22 ++++++++++++++ scripts/Dpkg/OpenPGP/Backend.pm | 23 +++++++++++++++ scripts/Dpkg/OpenPGP/Backend/GnuPG.pm | 23 +++++++++++++++ scripts/Dpkg/OpenPGP/Backend/SOP.pm | 24 +++++++++++++++ scripts/Dpkg/OpenPGP/Backend/Sequoia.pm | 23 +++++++++++++++ scripts/Dpkg/OpenPGP/ErrorCodes.pm | 23 +++++++++++++++ scripts/Dpkg/OpenPGP/KeyHandle.pm | 23 +++++++++++++++ scripts/Dpkg/Package.pm | 22 ++++++++++++++ scripts/Dpkg/Shlibs.pm | 22 ++++++++++++++ scripts/Dpkg/Shlibs/Cppfilt.pm | 23 +++++++++++++++ scripts/Dpkg/Shlibs/Objdump.pm | 23 +++++++++++++++ scripts/Dpkg/Shlibs/Objdump/Object.pm | 23 +++++++++++++++ scripts/Dpkg/Shlibs/Symbol.pm | 23 +++++++++++++++ scripts/Dpkg/Shlibs/SymbolFile.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Archive.pm | 23 +++++++++++++++ scripts/Dpkg/Source/BinaryFiles.pm | 23 +++++++++++++++ scripts/Dpkg/Source/Functions.pm | 23 +++++++++++++++ scripts/Dpkg/Source/Package/V1.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Package/V2.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Package/V3/Bzr.pm | 25 ++++++++++++++-- scripts/Dpkg/Source/Package/V3/Custom.pm | 23 +++++++++++++++ scripts/Dpkg/Source/Package/V3/Git.pm | 25 ++++++++++++++-- scripts/Dpkg/Source/Package/V3/Native.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Package/V3/Quilt.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Patch.pm | 22 ++++++++++++++ scripts/Dpkg/Source/Quilt.pm | 22 ++++++++++++++ scripts/Dpkg/Vendor/Debian.pm | 2 ++ scripts/Dpkg/Vendor/Default.pm | 2 ++ scripts/Dpkg/Vendor/Devuan.pm | 2 ++ scripts/Dpkg/Vendor/Ubuntu.pm | 2 ++ scripts/Makefile.am | 6 ++-- scripts/Test/Dpkg.pm | 23 +++++++++++++++ t/pod-spell.t | 3 ++ 43 files changed, 804 insertions(+), 19 deletions(-) diff --git a/dselect/methods/Dselect/Ftp.pm b/dselect/methods/Dselect/Ftp.pm index 154b511b4..733087e2c 100644 --- a/dselect/methods/Dselect/Ftp.pm +++ b/dselect/methods/Dselect/Ftp.pm @@ -10,6 +10,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dselect::Ftp - dselect FTP method support + +=head1 DESCRIPTION + +This module provides support functions for the FTP method. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dselect::Ftp; use strict; @@ -405,6 +419,14 @@ sub do_mdtm { return $time; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; __END__ diff --git a/scripts/Dpkg/BuildEnv.pm b/scripts/Dpkg/BuildEnv.pm index 1b6295bc8..2ab5707f8 100644 --- a/scripts/Dpkg/BuildEnv.pm +++ b/scripts/Dpkg/BuildEnv.pm @@ -34,6 +34,8 @@ Dpkg::BuildEnv - track build environment The Dpkg::BuildEnv module is used by dpkg-buildflags to track the build environment variables being used and modified. +B<Note>: This is a private module, its API can change at any time. + =head1 FUNCTIONS =over 4 diff --git a/scripts/Dpkg/BuildTypes.pm b/scripts/Dpkg/BuildTypes.pm index 9f20d0d6c..51f7af191 100644 --- a/scripts/Dpkg/BuildTypes.pm +++ b/scripts/Dpkg/BuildTypes.pm @@ -56,6 +56,8 @@ what artifacts need to be built. The build types are bit constants that are exported by default. Multiple types can be ORed. +B<Note>: This is a private module, its API can change at any time. + =head1 CONSTANTS =over 4 diff --git a/scripts/Dpkg/Control/HashCore/Tie.pm b/scripts/Dpkg/Control/HashCore/Tie.pm index 09b2ba14b..b0216037c 100644 --- a/scripts/Dpkg/Control/HashCore/Tie.pm +++ b/scripts/Dpkg/Control/HashCore/Tie.pm @@ -14,14 +14,26 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. -package Dpkg::Control::HashCore::Tie; +=encoding utf8 + +=head1 NAME + +Dpkg::Control::HashCore::Tie - ties a Dpkg::Control::Hash object + +=head1 DESCRIPTION + +This module provides a class that is used to tie a hash. +It implements hash-like functions by normalizing the name of fields received +in keys (using Dpkg::Control::Fields::field_capitalize). +It also stores the order in which fields have been added in order to be able +to dump them in the same order. +But the order information is stored in a parent object of type Dpkg::Control. -# This class is used to tie a hash. It implements hash-like functions by -# normalizing the name of fields received in keys (using -# Dpkg::Control::Fields::field_capitalize). It also stores the order in -# which fields have been added in order to be able to dump them in the -# same order. But the order information is stored in a parent object of -# type Dpkg::Control. +B<Note>: This is a private module, its API can change at any time. + +=cut + +package Dpkg::Control::HashCore::Tie; use strict; use warnings; @@ -40,10 +52,16 @@ use parent -norequire, qw(Tie::ExtraHash); # Dpkg::Control::Hash, hence ensuring that reference gets DESTROYed # properly. -# Dpkg::Control::Hash->new($parent) -# -# Return a reference to a tied hash implementing storage of simple -# "field: value" mapping as used in many Debian-specific files. +=head1 FUNCTIONS + +=over 4 + +=item Dpkg::Control::Hash->new($parent) + +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 $class = shift; @@ -126,4 +144,14 @@ sub NEXTKEY { return; } +=back + +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Control/Types.pm b/scripts/Dpkg/Control/Types.pm index 8dd1aa1b2..5537af614 100644 --- a/scripts/Dpkg/Control/Types.pm +++ b/scripts/Dpkg/Control/Types.pm @@ -53,6 +53,8 @@ want to use Dpkg::Control which also re-exports the same constants. This module has been introduced solely to avoid a dependency loop between Dpkg::Control and Dpkg::Control::Fields. +B<Note>: This is a private module, its API can change at any time. + =cut use constant { diff --git a/scripts/Dpkg/Dist/Files.pm b/scripts/Dpkg/Dist/Files.pm index ac58b98b0..e40efe506 100644 --- a/scripts/Dpkg/Dist/Files.pm +++ b/scripts/Dpkg/Dist/Files.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Dist::Files - handle built artifacts to distribute + +=head1 DESCRIPTION + +This module provides a class used to parse and write the F<debian/files> +file, as part of the list of built artifacts to include in an upload. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Dist::Files; use strict; @@ -195,4 +210,12 @@ sub output { return $str; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/ErrorHandling.pm b/scripts/Dpkg/ErrorHandling.pm index 81bc00d53..fdb84d8eb 100644 --- a/scripts/Dpkg/ErrorHandling.pm +++ b/scripts/Dpkg/ErrorHandling.pm @@ -11,6 +11,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::ErrorHandling - handle error conditions + +=head1 DESCRIPTION + +This module provides functions to handle all reporting and error handling. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::ErrorHandling; use strict; @@ -260,4 +274,12 @@ sub usageerr(@) exit(2); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/File.pm b/scripts/Dpkg/File.pm index dd3fd9f2c..8f1696266 100644 --- a/scripts/Dpkg/File.pm +++ b/scripts/Dpkg/File.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::File - file handling + +=head1 DESCRIPTION + +This module provides file handling support functions. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::File; use strict; @@ -76,4 +90,12 @@ sub file_touch { close $fh or syserr(g_('cannot write %s'), $file); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Getopt.pm b/scripts/Dpkg/Getopt.pm index bebe9f8d3..0094ee5c8 100644 --- a/scripts/Dpkg/Getopt.pm +++ b/scripts/Dpkg/Getopt.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Getopt - option parsing handling + +=head1 DESCRIPTION + +This module provides helper functions for option parsing, and complements +the system Getopt::Long module. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Getopt; use strict; @@ -45,4 +60,12 @@ sub normalize_options return @args; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Lock.pm b/scripts/Dpkg/Lock.pm index 63447795a..ff0df2505 100644 --- a/scripts/Dpkg/Lock.pm +++ b/scripts/Dpkg/Lock.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Lock - file locking support + +=head1 DESCRIPTION + +This module implements locking functions used to support parallel builds. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Lock; use strict; @@ -58,4 +72,12 @@ sub file_lock($$) { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP.pm b/scripts/Dpkg/OpenPGP.pm index 2e12ea75b..749bcf97f 100644 --- a/scripts/Dpkg/OpenPGP.pm +++ b/scripts/Dpkg/OpenPGP.pm @@ -13,6 +13,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP - multi-backend OpenPGP support + +=head1 DESCRIPTION + +This module provides a class for transparent multi-backend OpenPGP support. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP; use strict; @@ -152,4 +166,12 @@ sub inline_sign { return $self->{backend}->inline_sign($data, $inlinesigned, $key); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/Backend.pm b/scripts/Dpkg/OpenPGP/Backend.pm index 48cfd2267..ac1f0853f 100644 --- a/scripts/Dpkg/OpenPGP/Backend.pm +++ b/scripts/Dpkg/OpenPGP/Backend.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::Backend - OpenPGP backend base class + +=head1 DESCRIPTION + +This module provides an OpenPGP backend base class that specific +implementations should inherit from. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::Backend; use strict; @@ -124,4 +139,12 @@ sub inline_sign { return OPENPGP_UNSUPPORTED_SUBCMD; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/Backend/GnuPG.pm b/scripts/Dpkg/OpenPGP/Backend/GnuPG.pm index 53c317c0b..7e72f5bca 100644 --- a/scripts/Dpkg/OpenPGP/Backend/GnuPG.pm +++ b/scripts/Dpkg/OpenPGP/Backend/GnuPG.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::Backend::GnuPG - OpenPGP backend for GnuPG + +=head1 DESCRIPTION + +This module provides a class that implements the OpenPGP backend +for GnuPG. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::Backend::GnuPG; use strict; @@ -298,4 +313,12 @@ sub inline_sign { return OPENPGP_OK; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/Backend/SOP.pm b/scripts/Dpkg/OpenPGP/Backend/SOP.pm index 1c5073b62..00b8b184e 100644 --- a/scripts/Dpkg/OpenPGP/Backend/SOP.pm +++ b/scripts/Dpkg/OpenPGP/Backend/SOP.pm @@ -13,6 +13,22 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::Backend::SOP - OpenPGP backend for SOP + +=head1 DESCRIPTION + +This module provides a class that implements the OpenPGP backend +for the Stateless OpenPGP Command-Line Interface, as described in +L<https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli>. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::Backend::SOP; use strict; @@ -105,4 +121,12 @@ sub inline_sign qw(inline-sign --as clearsigned --), $key->handle); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/Backend/Sequoia.pm b/scripts/Dpkg/OpenPGP/Backend/Sequoia.pm index 531339340..842e3e441 100644 --- a/scripts/Dpkg/OpenPGP/Backend/Sequoia.pm +++ b/scripts/Dpkg/OpenPGP/Backend/Sequoia.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::Backend::Sequoia - OpenPGP backend for Sequoia + +=head1 DESCRIPTION + +This module provides a class that implements the OpenPGP backend +for Sequoia-PGP. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::Backend::Sequoia; use strict; @@ -120,4 +135,12 @@ sub inline_sign return OPENPGP_OK; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/ErrorCodes.pm b/scripts/Dpkg/OpenPGP/ErrorCodes.pm index b782e8891..015fc8f76 100644 --- a/scripts/Dpkg/OpenPGP/ErrorCodes.pm +++ b/scripts/Dpkg/OpenPGP/ErrorCodes.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::ErrorCodes - OpenPGP error codes + +=head1 DESCRIPTION + +This module provides error codes handling to be used by the various +OpenPGP backends. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::ErrorCodes; use strict; @@ -93,4 +108,12 @@ sub openpgp_errorcode_to_string return sprintf g_('error code %d'), $code; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/OpenPGP/KeyHandle.pm b/scripts/Dpkg/OpenPGP/KeyHandle.pm index 89ae44820..1f429ac75 100644 --- a/scripts/Dpkg/OpenPGP/KeyHandle.pm +++ b/scripts/Dpkg/OpenPGP/KeyHandle.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::OpenPGP::KeyHandle - OpenPGP key handle support + +=head1 DESCRIPTION + +This module provides a class to hold an OpenPGP key handle, as a way for +the code to refer to a key in an independent way. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::OpenPGP::KeyHandle; use strict; @@ -100,4 +115,12 @@ sub handle { return $self->{handle}; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Package.pm b/scripts/Dpkg/Package.pm index a38795f3f..ff9d61a85 100644 --- a/scripts/Dpkg/Package.pm +++ b/scripts/Dpkg/Package.pm @@ -15,6 +15,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Package - package properties handling + +=head1 DESCRIPTION + +This module provides functions to parse and validate package properties. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Package; use strict; @@ -72,4 +86,12 @@ sub set_source_name { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs.pm b/scripts/Dpkg/Shlibs.pm index 22fecc45b..764ac87b2 100644 --- a/scripts/Dpkg/Shlibs.pm +++ b/scripts/Dpkg/Shlibs.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs - shared library location handling + +=head1 DESCRIPTION + +This module provides functions to locate shared libraries. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs; use strict; @@ -181,4 +195,12 @@ sub find_library { return @libs; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs/Cppfilt.pm b/scripts/Dpkg/Shlibs/Cppfilt.pm index c2a4756fd..89f923bd4 100644 --- a/scripts/Dpkg/Shlibs/Cppfilt.pm +++ b/scripts/Dpkg/Shlibs/Cppfilt.pm @@ -14,6 +14,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs::Cppfilt - C++ symbol mangling support via c++filt + +=head1 DESCRIPTION + +This module provides functions that wrap over c++filt for its easy and +fast usage. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs::Cppfilt; use strict; @@ -117,4 +132,12 @@ END { $? = $exitcode; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs/Objdump.pm b/scripts/Dpkg/Shlibs/Objdump.pm index 8cd3fbc70..2d9a7995a 100644 --- a/scripts/Dpkg/Shlibs/Objdump.pm +++ b/scripts/Dpkg/Shlibs/Objdump.pm @@ -14,6 +14,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs::Objdump - symbol support via objdump + +=head1 DESCRIPTION + +This module provides a class that wraps objdump to handle symbols and +their attributes from a shared object. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs::Objdump; use strict; @@ -242,4 +257,12 @@ sub is_elf { return $result; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs/Objdump/Object.pm b/scripts/Dpkg/Shlibs/Objdump/Object.pm index c673945f9..bde1b59da 100644 --- a/scripts/Dpkg/Shlibs/Objdump/Object.pm +++ b/scripts/Dpkg/Shlibs/Objdump/Object.pm @@ -14,6 +14,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs::Objdump::Object - represent an object from objdump output + +=head1 DESCRIPTION + +This module provides a class to represent an object parsed from +L<objdump(1)> output. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs::Objdump::Object; use strict; @@ -354,4 +369,12 @@ sub is_public_library { && exists $self->{SONAME} && $self->{SONAME}; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs/Symbol.pm b/scripts/Dpkg/Shlibs/Symbol.pm index e6460ce71..6a712e168 100644 --- a/scripts/Dpkg/Shlibs/Symbol.pm +++ b/scripts/Dpkg/Shlibs/Symbol.pm @@ -14,6 +14,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs::Symbol - represent an object file symbol + +=head1 DESCRIPTION + +This module provides a class to handle symbols from an executable or +shared object file. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs::Symbol; use strict; @@ -528,4 +543,12 @@ sub matches_rawname { return $ok; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Shlibs/SymbolFile.pm b/scripts/Dpkg/Shlibs/SymbolFile.pm index d492055b4..7be8b32a9 100644 --- a/scripts/Dpkg/Shlibs/SymbolFile.pm +++ b/scripts/Dpkg/Shlibs/SymbolFile.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Shlibs::SymbolFile - represent a symbols file + +=head1 DESCRIPTION + +This module provides a class to handle symbols files. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Shlibs::SymbolFile; use strict; @@ -694,4 +708,12 @@ sub get_lost_libs { return $ref->get_new_libs($self); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Archive.pm b/scripts/Dpkg/Source/Archive.pm index 88e6700fd..c70d1619c 100644 --- a/scripts/Dpkg/Source/Archive.pm +++ b/scripts/Dpkg/Source/Archive.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Archive - source tarball archive support + +=head1 DESCRIPTION + +This module provides a class that implements support for handling +source tarballs. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Archive; use strict; @@ -237,4 +252,12 @@ sub extract { erasedir($tmp); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/BinaryFiles.pm b/scripts/Dpkg/Source/BinaryFiles.pm index 48c84c8fc..47e3ebf80 100644 --- a/scripts/Dpkg/Source/BinaryFiles.pm +++ b/scripts/Dpkg/Source/BinaryFiles.pm @@ -14,6 +14,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::BinaryFiles - manipulate debian/source/include-binaries files + +=head1 DESCRIPTION + +This module provides a class to handle the F<debian/source/include-binaries> +file. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::BinaryFiles; use strict; @@ -158,4 +173,12 @@ sub detect_binary_files { if $unwanted_binaries; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Functions.pm b/scripts/Dpkg/Source/Functions.pm index 0576657ea..fd62d5638 100644 --- a/scripts/Dpkg/Source/Functions.pm +++ b/scripts/Dpkg/Source/Functions.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Functions - miscellaneous source package handling functions + +=head1 DESCRIPTION + +This module provides a set of miscellaneous helper functions to handle +source packages. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Functions; use strict; @@ -121,4 +136,12 @@ sub is_binary($) { return $res >= 0; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V1.pm b/scripts/Dpkg/Source/Package/V1.pm index 96e29322b..d15977e85 100644 --- a/scripts/Dpkg/Source/Package/V1.pm +++ b/scripts/Dpkg/Source/Package/V1.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V1 - class for source format 1.0 + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 1.0. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V1; use strict; @@ -509,4 +523,12 @@ sub do_build { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V2.pm b/scripts/Dpkg/Source/Package/V2.pm index b3c21e536..76753937a 100644 --- a/scripts/Dpkg/Source/Package/V2.pm +++ b/scripts/Dpkg/Source/Package/V2.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V2 - class for source format 2.0 + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 2.0. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V2; use strict; @@ -741,4 +755,12 @@ sub do_commit { info(g_('local changes have been recorded in a new patch: %s'), $patch); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V3/Bzr.pm b/scripts/Dpkg/Source/Package/V3/Bzr.pm index 2f18fee77..74e39ec60 100644 --- a/scripts/Dpkg/Source/Package/V3/Bzr.pm +++ b/scripts/Dpkg/Source/Package/V3/Bzr.pm @@ -1,6 +1,3 @@ -# -# bzr support for dpkg-source -# # Copyright © 2007 Colin Watson <[email protected]>. # Based on Dpkg::Source::Package::V3_0::git, which is: # Copyright © 2007 Joey Hess <[email protected]>. @@ -19,6 +16,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V3::Bzr - class for source format 3.0 (bzr) + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 3.0 (bzr). + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V3::Bzr; use strict; @@ -210,4 +221,12 @@ sub do_extract { chdir $old_cwd or syserr(g_("unable to chdir to '%s'"), $old_cwd); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V3/Custom.pm b/scripts/Dpkg/Source/Package/V3/Custom.pm index 63f176913..fd01db863 100644 --- a/scripts/Dpkg/Source/Package/V3/Custom.pm +++ b/scripts/Dpkg/Source/Package/V3/Custom.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V3::Custom - class for source format 3.0 (custom) + +=head1 DESCRIPTION + +This module provides a class to handle the pseudo source package +format 3.0 (custom). + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V3::Custom; use strict; @@ -71,4 +86,12 @@ sub do_build { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V3/Git.pm b/scripts/Dpkg/Source/Package/V3/Git.pm index 721036a6b..f555f6ef0 100644 --- a/scripts/Dpkg/Source/Package/V3/Git.pm +++ b/scripts/Dpkg/Source/Package/V3/Git.pm @@ -1,6 +1,3 @@ -# -# git support for dpkg-source -# # Copyright © 2007,2010 Joey Hess <[email protected]>. # Copyright © 2008 Frank Lichtenheld <[email protected]> # @@ -17,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V3::Git - class for source format 3.0 (git) + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 3.0 (git). + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V3::Git; use strict; @@ -280,4 +291,12 @@ sub do_extract { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V3/Native.pm b/scripts/Dpkg/Source/Package/V3/Native.pm index 933315a73..2502dc016 100644 --- a/scripts/Dpkg/Source/Package/V3/Native.pm +++ b/scripts/Dpkg/Source/Package/V3/Native.pm @@ -13,6 +13,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V3::Native - class for source format 3.0 (native) + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 3.0 (native). + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V3::Native; use strict; @@ -118,4 +132,12 @@ sub do_build { $self->add_file($tarname); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Package/V3/Quilt.pm b/scripts/Dpkg/Source/Package/V3/Quilt.pm index 1359168d6..dab3bbd61 100644 --- a/scripts/Dpkg/Source/Package/V3/Quilt.pm +++ b/scripts/Dpkg/Source/Package/V3/Quilt.pm @@ -13,6 +13,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Package::V3::Quilt - class for source format 3.0 (quilt) + +=head1 DESCRIPTION + +This module provides a class to handle the source package format 3.0 (quilt). + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Package::V3::Quilt; use strict; @@ -266,4 +280,12 @@ sub register_patch { return $patch; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Patch.pm b/scripts/Dpkg/Source/Patch.pm index e670898fc..c852859ee 100644 --- a/scripts/Dpkg/Source/Patch.pm +++ b/scripts/Dpkg/Source/Patch.pm @@ -14,6 +14,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Patch - represent a patch file + +=head1 DESCRIPTION + +This module provides a class to handle patch files. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Patch; use strict; @@ -694,4 +708,12 @@ sub get_type { } } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Source/Quilt.pm b/scripts/Dpkg/Source/Quilt.pm index 3e655fae9..99b11958a 100644 --- a/scripts/Dpkg/Source/Quilt.pm +++ b/scripts/Dpkg/Source/Quilt.pm @@ -13,6 +13,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Dpkg::Source::Quilt - represent a quilt patch queue + +=head1 DESCRIPTION + +This module provides a class to handle quilt patch queues. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Dpkg::Source::Quilt; use strict; @@ -380,4 +394,12 @@ sub restore_quilt_backup_files { }, $patch_dir); } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/scripts/Dpkg/Vendor/Debian.pm b/scripts/Dpkg/Vendor/Debian.pm index 06aa49ad6..43940625e 100644 --- a/scripts/Dpkg/Vendor/Debian.pm +++ b/scripts/Dpkg/Vendor/Debian.pm @@ -43,6 +43,8 @@ Dpkg::Vendor::Debian - Debian vendor class This vendor class customizes the behaviour of dpkg scripts for Debian specific behavior and policies. +B<Note>: This is a private module, its API can change at any time. + =cut sub run_hook { diff --git a/scripts/Dpkg/Vendor/Default.pm b/scripts/Dpkg/Vendor/Default.pm index 8362b5b1a..004b6611d 100644 --- a/scripts/Dpkg/Vendor/Default.pm +++ b/scripts/Dpkg/Vendor/Default.pm @@ -44,6 +44,8 @@ extended period of time. If you run an important distribution that makes use of vendor hooks, you'd better submit them for integration so that we avoid breaking your code. +B<Note>: This is a private module, its API can change at any time. + =head1 METHODS =over 4 diff --git a/scripts/Dpkg/Vendor/Devuan.pm b/scripts/Dpkg/Vendor/Devuan.pm index 661dc9ed1..f7aa2c454 100644 --- a/scripts/Dpkg/Vendor/Devuan.pm +++ b/scripts/Dpkg/Vendor/Devuan.pm @@ -33,6 +33,8 @@ Dpkg::Vendor::Devuan - Devuan vendor class This vendor class customizes the behaviour of dpkg scripts for Devuan specific behavior and policies. +B<Note>: This is a private module, its API can change at any time. + =cut sub run_hook { diff --git a/scripts/Dpkg/Vendor/Ubuntu.pm b/scripts/Dpkg/Vendor/Ubuntu.pm index 9c77519d7..f3b716239 100644 --- a/scripts/Dpkg/Vendor/Ubuntu.pm +++ b/scripts/Dpkg/Vendor/Ubuntu.pm @@ -43,6 +43,8 @@ Dpkg::Vendor::Ubuntu - Ubuntu vendor class This vendor class customizes the behaviour of dpkg scripts for Ubuntu specific behavior and policies. +B<Note>: This is a private module, its API can change at any time. + =cut sub run_hook { diff --git a/scripts/Makefile.am b/scripts/Makefile.am index 58471b266..81690df6c 100644 --- a/scripts/Makefile.am +++ b/scripts/Makefile.am @@ -176,8 +176,10 @@ if BUILD_POD_DOC $(POD2MAN) $(POD2MAN_OPTS) --center=libdpkg-perl \ --name="$$name" --section=$(man_perl_section) $(srcdir)/$$module \ >$(DESTDIR)$(man3dir)/$$name.$(man_perl_section); \ - test -s $(DESTDIR)$(man3dir)/$$name.$(man_perl_section) || \ - rm -f $(DESTDIR)$(man3dir)/$$name.$(man_perl_section); \ + if ! [ -s "$(DESTDIR)$(man3dir)/$$name.$(man_perl_section)" ]; then \ + echo "error: empty $(man3dir)/$$name.$(man_perl_section)" 2>&1; \ + exit 1; \ + fi; \ done endif diff --git a/scripts/Test/Dpkg.pm b/scripts/Test/Dpkg.pm index 2cbbb02f4..688236e4f 100644 --- a/scripts/Test/Dpkg.pm +++ b/scripts/Test/Dpkg.pm @@ -13,6 +13,21 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>. +=encoding utf8 + +=head1 NAME + +Test::Dpkg - helpers for test scripts for the dpkg suite + +=head1 DESCRIPTION + +This module provides helper functions to ease implementing test scripts +for the dpkg suite of tools. + +B<Note>: This is a private module, its API can change at any time. + +=cut + package Test::Dpkg; use strict; @@ -224,4 +239,12 @@ sub test_neutralize_checksums rename $filenamenew, $filename or die "cannot rename $filenamenew to $filename"; } +=head1 CHANGES + +=head2 Version 0.xx + +This is a private module. + +=cut + 1; diff --git a/t/pod-spell.t b/t/pod-spell.t index b6bf46b40..5f0d27a63 100644 --- a/t/pod-spell.t +++ b/t/pod-spell.t @@ -55,6 +55,7 @@ archqual backport buildinfo bzip2 +bzr canonicalized checksum checksums @@ -74,6 +75,7 @@ dpkg-gencontrol dpkg-parsechangelog dpkg-mergechangelog dsc +dselect dup'ed env envvar @@ -90,6 +92,7 @@ lzma modelines multiarch nocheck +objdump qa quiesced reportfile -- Dpkg.Org's dpkg
