[Reproducible-commits] [dpkg] 12/105: man, Dpkg::Vendor: Document the format of the origin filename

[Niko Tyni]

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

ntyni pushed a commit to branch ntyni/reproducible_builds
in repository dpkg.

commit fa72f4b18f88bab1dae78a5e519512807dec1e6c
Author: Guillem Jover <guillem at debian.org>
Date:   Tue Mar 22 10:29:18 2016 +0100

    man, Dpkg::Vendor: Document the format of the origin filename
    
    Prompted-by: Martin Michlmayr <tbm at debian.org>
---
 debian/changelog       |  1 +
 man/deb-origin.5       | 13 +++++++++++--
 scripts/Dpkg/Vendor.pm |  9 ++++++++-
 3 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 0379b3a..ac57a9e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -93,6 +93,7 @@ dpkg (1.18.5) UNRELEASED; urgency=medium
       the template symbol files are described in dpkg-gensymbols(1).
       Closes: #795163
     - Update field requirements of control file formats to match dpkg reality.
+    - Document the format of the origins filename in deb-origin(5).
 
   [ Updated programs translations ]
   * Portuguese (Miguel Figueiredo).
diff --git a/man/deb-origin.5 b/man/deb-origin.5
index 0c13772..60362a6 100644
--- a/man/deb-origin.5
+++ b/man/deb-origin.5
@@ -23,13 +23,22 @@ deb\-origin \- Vendor-specific information files
 .BI /etc/dpkg/origins/ filename
 .SH DESCRIPTION
 The files in \fB/etc/dpkg/origins\fP can provide information about
-various vendors who are providing Debian packages. They contain a
-number of fields, or comments when the line starts with \(oq\fB#\fP\(cq.
+various vendors who are providing Debian packages.
+
+They contain a number of fields, or comments when the line starts with
+\(oq\fB#\fP\(cq.
 Each field begins with a tag, such as \fBVendor\fP or \fBParent\fP,
 followed by a colon and the body of the field. Fields are delimited
 only by field tags. In other words, field text may be multiple lines
 in length, but the tools will join lines when processing the body of
 the field.
+
+The file should be named according to the vendor name.
+The usual convention is to name the vendor file using the vendor name
+in all lowercase, but some variation is permitted.
+Namely, spaces are mapped to dashes (\(oq\fB\-\fP\(cq), and the file
+can have the same casing as the value in \fBVendor\fP field, or it can
+be capitalized.
 .SH FIELDS
 .TP
 .BR Vendor: " \fIvendor-name\fP (required)"
diff --git a/scripts/Dpkg/Vendor.pm b/scripts/Dpkg/Vendor.pm
index 4ddcc84..f40ed27 100644
--- a/scripts/Dpkg/Vendor.pm
+++ b/scripts/Dpkg/Vendor.pm
@@ -61,7 +61,10 @@ the relationship by listing the base distribution in the Parent field:
 
   Parent: Debian
 
-The file should be named according to the vendor name.
+The file should be named according to the vendor name. The usual convention
+is to name the vendor file using the vendor name in all lowercase, but some
+variation is permitted. Namely, spaces are mapped to dashes ('-'), and the
+file can have the same casing as the Vendor field, or it can be capitalized.
 
 =head1 FUNCTIONS
 
@@ -199,6 +202,10 @@ New function: get_vendor_dir().
 
 Mark the module as public.
 
+=head1 SEE ALSO
+
+deb-origin(5).
+
 =cut
 
 1;

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