Bug#702704: libparse-debcontrol-perl: Incorrect return type documented for parse methods

[James McCoy]

Package: libparse-debcontrol-perl
Version: 2.005-3
Severity: minor


>From the man page:
    …
               $data = $parser->parse_mem($control_data, $options);
               $data = $parser->parse_file('./debian/control', $options);
               $data = $parser->parse_web($url, $options);
    …
       ·   "parse_file($control_filename,$options)"

           Takes a filename as a scalar and an optional hashref of options (see below).  Will parse as much as it can, warning (if "DEBUG"ing is turned on) on parsing errors.

           Returns an array of hashrefs, containing the data in the control file, split up by stanza.  Stanzas are deliniated by newlines, and multi-line fields are expressed as such post-parsing.  Single
           periods are treated as special extra newline deliniators, per convention.  Whitespace is also stripped off of lines as to make it less-easy to make mistakes with hand-written conf files).
    …

The example shows that an arrayref is returned, but the actual
explanation incorrectly states it's an array.

-- System Information:
Debian Release: 7.0
  APT prefers unstable
  APT policy: (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 3.8-trunk-amd64 (SMP w/8 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages libparse-debcontrol-perl depends on:
ii  liberror-perl          0.17-1
ii  libexporter-lite-perl  0.02-2
ii  libio-stringy-perl     2.110-5
ii  libwww-perl            6.04-1
ii  perl                   5.14.2-19

Versions of packages libparse-debcontrol-perl recommends:
ii  libtie-ixhash-perl  1.23-1

libparse-debcontrol-perl suggests no packages.

-- no debconf information