/ 
Dpkg-1.22.11
River stage one • 6 direct dependents • 8 total dependents
/ Dpkg::Changelog::Parse

NAME

Dpkg::Changelog::Parse - generic changelog parser for dpkg-parsechangelog

DESCRIPTION

This module provides a set of functions which reproduce all the features of dpkg-parsechangelog.

FUNCTIONS

$fields = changelog_parse(%opt)

This function will parse a changelog. In list context, it returns as many Dpkg::Control objects as the parser did create. In scalar context, it will return only the first one. If the parser did not return any data, it will return an empty list in list context or undef on scalar context. If the parser failed, it will die. Any parse errors will be printed as warnings on standard error, but this can be disabled by passing $opt{verbose} to 0.

The changelog file that is parsed is debian/changelog by default but it can be overridden with $opt{file}. The changelog name used in output messages can be specified with $opt{label}, otherwise it will default to $opt{file}. The default output format is "dpkg" but it can be overridden with $opt{format}.

The parsing itself is done by a parser module (searched in the standard perl library directories. That module is named according to the format that it is able to parse, with the name capitalized. By default it is either Dpkg::Changelog::Debian (from the "debian" format) or the format name looked up in the 40 last lines of the changelog itself (extracted with this perl regular expression "\schangelog-format:\s+([0-9a-z]+)\W"). But it can be overridden with $opt{changelogformat}.

If $opt{compression} is false, the file will be loaded without compression support, otherwise by default compression support is disabled if the file is the default.

All the other keys in %opt are forwarded to the parser module constructor.

CHANGES

Version 2.01 (dpkg 1.20.6)

New option: 'verbose' in changelog_parse().

Version 2.00 (dpkg 1.20.0)

Remove functions: changelog_parse_debian(), changelog_parse_plugin().

Remove warnings: For options 'forceplugin', 'libdir'.

Version 1.03 (dpkg 1.19.0)

New option: 'compression' in changelog_parse().

Version 1.02 (dpkg 1.18.8)

Deprecated functions: changelog_parse_debian(), changelog_parse_plugin().

Obsolete options: forceplugin, libdir.

Version 1.01 (dpkg 1.18.2)

New functions: changelog_parse_debian(), changelog_parse_plugin().

Version 1.00 (dpkg 1.15.6)

Mark the module as public.