This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch master in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=b89c8fd35c09df0df61f3424a630241bf4d79111 commit b89c8fd35c09df0df61f3424a630241bf4d79111 Author: Guillem Jover <[email protected]> AuthorDate: Thu Sep 27 04:56:37 2018 +0200 Dpkg: Add documentation about the module hierarchy and API --- debian/changelog | 1 + scripts/Dpkg.pm | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 166 insertions(+) diff --git a/debian/changelog b/debian/changelog index 0ed0de87a..4d7e8f1ab 100644 --- a/debian/changelog +++ b/debian/changelog @@ -17,6 +17,7 @@ dpkg (1.19.2) UNRELEASED; urgency=medium - dpkg(1): Clarify which fields are affected by dependency options. Prompted by James Clarke <[email protected]>. - dpkg-query(1): Document the PAGER environment variable usage. + - Dpkg(1): Add POD documentation about the module hierarchy and API. * Build system: - Distribute a LICENSE file on CPAN. - Do not make the Build.PL script executable. diff --git a/scripts/Dpkg.pm b/scripts/Dpkg.pm index 7f06b15e6..fd9259ecb 100644 --- a/scripts/Dpkg.pm +++ b/scripts/Dpkg.pm @@ -24,6 +24,8 @@ Dpkg - module with core variables The Dpkg module provides a set of variables with information concerning this system installation. +It is also the entry point to the Dpkg module hierarchy. + =cut use strict; @@ -119,6 +121,169 @@ our $dpkglibdir = $LIBDIR; our $pkgdatadir = $DATADIR; ## use critic +=head1 MODULES + +The following is the list of public modules within the Dpkg hierarchy. Only +modules with versions 1.00 or higher, and only the interfaces documented in +their POD are considered public. + +=over + +=item L<Dpkg> + +This module, core variables. + +=item L<Dpkg::Arch> + +Architecture handling functions. + +=item L<Dpkg::Build::Info> + +Build information functions. + +=item L<Dpkg::BuildFlags> + +Set, modify and query compilation build flags. + +=item L<Dpkg::BuildOptions> + +Parse and manipulate B<DEB_BUILD_OPTIONS>. + +=item L<Dpkg::BuildProfiles> + +Parse and manipulate build profiles. + +=item L<Dpkg::Changelog> + +Parse changelogs. + +=item L<Dpkg::Changelog::Entry> + +Represents a changelog entry. + +=item L<Dpkg::Changelog::Parse> + +Generic changelog parser for F<dpkg-parsechangelog>. + +=item L<Dpkg::Checksums> + +Generate and parse checksums. + +=item L<Dpkg::Compression> + +Simple database of available compression methods. + +=item L<Dpkg::Compression::FileHandle> + +Transparently compress and decompress files. + +=item L<Dpkg::Compression::Process> + +Wrapper around compression tools. + +=item L<Dpkg::Conf> + +Parse F<dpkg> configuration files. + +=item L<Dpkg::Control> + +Parse and manipulate Debian control information (F<.dsc>, F<.changes>, +F<Packages>/F<Sources> entries, etc.). + +=item L<Dpkg::Control::Changelog> + +Represent fields output by F<dpkg-parsechangelog>. + +=item L<Dpkg::Control::Fields> + +Manage (list of known) control fields. + +=item L<Dpkg::Control::Hash> + +Parse and manipulate a block of RFC822-like fields. + +=item L<Dpkg::Control::Info> + +Parse files like F<debian/control>. + +=item L<Dpkg::Control::Tests> + +Parse files like F<debian/tests/control>. + +=item L<Dpkg::Control::Tests::Entry> + +Represents a F<debian/tests/control> stanza. + +=item L<Dpkg::Deps> + +Parse and manipulate dependencies. + +=item L<Dpkg::Deps::Simple> + +Represents a single dependency statement. + +=item L<Dpkg::Deps::Multiple> + +Base module to represent multiple dependencies. + +=item L<Dpkg::Deps::Union> + +List of unrelated dependencies. + +=item L<Dpkg::Deps::AND> + +List of AND dependencies. + +=item L<Dpkg::Deps::OR> + +List of OR dependencies. + +=item L<Dpkg::Deps::KnownFacts> + +List of installed and virtual packages. + +=item L<Dpkg::Exit> + +Push, pop and run exit handlers. + +=item L<Dpkg::Gettext> + +Wrapper around L<Locale::gettext>. + +=item L<Dpkg::IPC> + +Spawn sub-processes and feed/retrieve data. + +=item L<Dpkg::Index> + +Collections of L<Dpkg::Control> (F<Packages>/F<Sources> files for example). + +=item L<Dpkg::Interface::Storable> + +Base object serializer. + +=item L<Dpkg::Path> + +Common path handling functions. + +=item L<Dpkg::Source::Package> + +Extract Debian source packages. + +=item L<Dpkg::Substvars> + +Substitute variables in strings. + +=item L<Dpkg::Vendor> + +Identify current distribution vendor. + +=item L<Dpkg::Version> + +Parse and manipulate Debian package versions. + +=back + =head1 CHANGES =head2 Version 1.03 (dpkg 1.18.24) -- Dpkg.Org's dpkg
