[dpkg] 54/192: Dpkg::Index: Itemize the CTRL_* constants in the POD

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch pu/reproducible_builds
in repository dpkg.

commit 13a9dcf9c0396fe959a95508514695985ee98522
Author: Guillem Jover <guillem at debian.org>
Date:   Tue Feb 14 13:55:03 2017 +0100

    Dpkg::Index: Itemize the CTRL_* constants in the POD
---
 debian/changelog      |  1 +
 scripts/Dpkg/Index.pm | 50 +++++++++++++++++++++++++++++++++++++++++---------
 2 files changed, 42 insertions(+), 9 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index b131cf1..5e31963 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -12,6 +12,7 @@ dpkg (1.19.0) UNRELEASED; urgency=medium
     - Clarify behavior for dpkg-maintscript-helper. Closes: #857852
     - Use <command-string> instead of <command> for -c argument value in
       dpkg-architecture(1). Reported by Johannes Schauer <josch at debian.org>.
+    - Itemize the CTRL_* constants in the Dpkg::Index POD.
   * Build system:
     - Require Perl 5.20.2, the version in Debian oldstable (jessie).
     - Use new gcc-7 -Wrestrict and -Wshift-negative-value warnings if
diff --git a/scripts/Dpkg/Index.pm b/scripts/Dpkg/Index.pm
index 4b125c1..ebeafcb 100644
--- a/scripts/Dpkg/Index.pm
+++ b/scripts/Dpkg/Index.pm
@@ -75,15 +75,47 @@ The "type" option is checked first to define default values for other
 options. Here are the relevant options: "get_key_func" is a function
 returning a key for the item passed in parameters. The index can only
 contain one item with a given key. The function used depends on the
-type: for CTRL_INFO_PKG, CTRL_INDEX_SRC, CTRL_INDEX_PKG and CTRL_PKG_DEB
-it's simply the Package field; for CTRL_PKG_SRC and CTRL_INFO_SRC, it's
-the Source field; for CTRL_CHANGELOG it's the Source and the Version
-fields (concatenated with an intermediary "_"); for CTRL_TESTS is either
-the Tests or Test-Command fields; for CTRL_FILE_CHANGES it's
-the Source, Version and Architecture fields (concatenated with "_");
-for CTRL_FILE_VENDOR it's the Vendor field; for CTRL_FILE_STATUS it's the
-Package and Architecture fields (concatenated with "_"). Otherwise it's
-the Package field by default.
+type:
+
+=over
+
+=item *
+
+for CTRL_INFO_SRC and CTRL_PKG_SRC, it is the Source field;
+
+=item *
+
+for CTRL_INFO_PKG, CTRL_INDEX_SRC, CTRL_INDEX_PKG and CTRL_PKG_DEB
+it is simply the Package field;
+
+=item *
+
+for CTRL_CHANGELOG it is the Source and the Version fields (concatenated
+with an intermediary "_");
+
+=item *
+
+for CTRL_TESTS is either the Tests or Test-Command fields;
+
+=item *
+
+for CTRL_FILE_CHANGES it is the Source, Version and Architecture fields
+(concatenated with "_");
+
+=item *
+
+for CTRL_FILE_VENDOR it is the Vendor field;
+
+=item *
+
+for CTRL_FILE_STATUS it is the Package and Architecture fields (concatenated
+with "_");
+
+=item *
+
+otherwise it is the Package field by default.
+
+=back
 
 =cut
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/dpkg.git