diff options
| author | Guillem Jover <guillem@debian.org> | 2019-11-05 12:57:13 +0100 |
|---|---|---|
| committer | Guillem Jover <guillem@debian.org> | 2019-11-26 02:42:45 +0100 |
| commit | 2eafcd122aa4e772cd6bb40c3eb82ac27aff3646 (patch) | |
| tree | f1e7c4145d0a696207ca19a6663e690220d58ebf | |
| parent | 7ab69d4acbdabd3af0f8c27801527750505c1a11 (diff) | |
| download | dpkg-2eafcd122aa4e772cd6bb40c3eb82ac27aff3646.tar.gz | |
Dpkg::Changelog: Clarify inheritance and implementation references
Make it clear that these classes inherit from some other base class,
which will contain the missing documentation.
Prompted-by: intrigeri <intrigeri@debian.org>
| -rw-r--r-- | debian/changelog | 3 | ||||
| -rw-r--r-- | scripts/Dpkg/Changelog/Debian.pm | 13 | ||||
| -rw-r--r-- | scripts/Dpkg/Changelog/Entry/Debian.pm | 7 |
3 files changed, 17 insertions, 6 deletions
diff --git a/debian/changelog b/debian/changelog index d41eaa836..3874bc4e1 100644 --- a/debian/changelog +++ b/debian/changelog @@ -88,6 +88,9 @@ dpkg (1.20.0) UNRELEASED; urgency=medium - man: Move template symbol documentation into new deb-src-symbols(5). - Dpkg::Changelog::Parse: Remove $ sigil from option names in POD. - Dpkg: Say class instead of object when appropriate. + - Dpkg::Changelog: Clarify that these classes inherit from some other + base class, which will contain the missing documentation. + Prompted by intrigeri <intrigeri@debian.org>. * Code internals: - Dpkg::Source::Package: Refactor original tarball handling. - perl: Use File::Copy instead of spawning mv/cp commands. diff --git a/scripts/Dpkg/Changelog/Debian.pm b/scripts/Dpkg/Changelog/Debian.pm index 937acb5e0..a85f3af12 100644 --- a/scripts/Dpkg/Changelog/Debian.pm +++ b/scripts/Dpkg/Changelog/Debian.pm @@ -24,6 +24,12 @@ Dpkg::Changelog::Debian - parse Debian changelogs =head1 DESCRIPTION +This class represents a Debian changelog file as an array of changelog +entries (Dpkg::Changelog::Entry::Debian). +It implements the generic interface Dpkg::Changelog. +Only methods specific to this implementation are described below, +the rest are inherited. + Dpkg::Changelog::Debian parses Debian changelogs as described in deb-changelog(5). @@ -118,10 +124,11 @@ my $ancient_delimiter_re = qr{ =over 4 -=item $c->parse($fh, $description) +=item $count = $c->parse($fh, $description) -Read the filehandle and parse a Debian changelog in it. The data in the -object is reset before parsing new data. +Read the filehandle and parse a Debian changelog in it, to store the entries +as an array of Dpkg::Changelog::Entry::Debian objects. +Any previous entries in the object are reset before parsing new data. Returns the number of changelog entries that have been parsed with success. diff --git a/scripts/Dpkg/Changelog/Entry/Debian.pm b/scripts/Dpkg/Changelog/Entry/Debian.pm index 8658ae493..1e7daf55b 100644 --- a/scripts/Dpkg/Changelog/Entry/Debian.pm +++ b/scripts/Dpkg/Changelog/Entry/Debian.pm @@ -45,9 +45,10 @@ Dpkg::Changelog::Entry::Debian - represents a Debian changelog entry =head1 DESCRIPTION -This class represents a Debian changelog entry. It implements the -generic interface Dpkg::Changelog::Entry. Only functions specific to this -implementation are described below. +This class represents a Debian changelog entry. +It implements the generic interface Dpkg::Changelog::Entry. +Only functions specific to this implementation are described below, +the rest are inherited. =cut |