[Reproducible-commits] [dpkg] 27/61: man: Mark each individual required field as such

[Jérémy Bobbio]

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

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

commit 244f260024836a0a9a04b1f42f4858d1ee142af7
Author: Guillem Jover <guillem at debian.org>
Date:   Tue Sep 15 02:42:49 2015 +0200

    man: Mark each individual required field as such
    
    Do not use segregated sections for required and optional fields, they
    are more difficult to organize this way.
---
 debian/changelog  |  2 ++
 man/deb-control.5 | 12 +++++-------
 man/deb-origin.5  |  5 ++---
 3 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index a607d00..17e3aee 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -40,6 +40,8 @@ dpkg (1.18.3) UNRELEASED; urgency=low
   * Documentation:
     - Fix typos for --predep-package option name. Closes: #794688
     - Add missing dashes to package-list in deb-src-control(5).
+    - Mark each individual required field as such, instead of using segregated
+      sections.
 
   [ Updated programs translations ]
   * Catalan (Jordi Mallach).
diff --git a/man/deb-control.5 b/man/deb-control.5
index 2b0692b..4dd61a9 100644
--- a/man/deb-control.5
+++ b/man/deb-control.5
@@ -41,25 +41,25 @@ in the case of the
 .B Description
 field, see below).
 .
-.SH REQUIRED FIELDS
+.SH FIELDS
 .TP
-.BI Package: " package-name"
+.BR Package: " \fIpackage-name\fP (required)"
 The value of this field determines the package name, and is used to
 generate file names by most installation tools.
 .TP
-.BI Version: " version-string"
+.BR Version: " \fIversion-string\fP (required)"
 Typically, this is the original package's version number in whatever form
 the program's author uses. It may also include a Debian revision number
 (for non-native packages). The exact format and sorting algorithm
 are described in
 .BR deb\-version (5).
 .TP
-.BI Maintainer: " fullname-email"
+.BR Maintainer: " \fIfullname-email\fP (required)"
 Should be in the format \(lqJoe Bloggs <jbloggs at foo.com>\(rq, and is typically
 the person who created the package, as opposed to the author of the
 software that was packaged.
 .TP
-.BI Description: " short-description"
+.BR Description: " \fIshort-description\fP (required)"
 .TQ
 .BI " " "long-description"
 .br
@@ -68,8 +68,6 @@ first line (after the \fBDescription\fP field). The following lines should be
 used as a longer, more detailed description. Each line of the long description
 must be preceded by a space, and blank lines in the long description must
 contain a single \(oq\fB.\fP\(cq following the preceding space.
-.
-.SH OPTIONAL FIELDS
 .TP
 .BI Section: " section"
 This is a general field that gives the package a category based on the
diff --git a/man/deb-origin.5 b/man/deb-origin.5
index 5addf5e..0c13772 100644
--- a/man/deb-origin.5
+++ b/man/deb-origin.5
@@ -30,11 +30,10 @@ 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.
-.SH REQUIRED FIELDS
+.SH FIELDS
 .TP
-.BI Vendor: " vendor-name"
+.BR Vendor: " \fIvendor-name\fP (required)"
 The value of this field determines the vendor name.
-.SH OPTIONAL FIELDS
 .TP
 .BI Vendor\-URL: " vendor-url"
 The value of this field determines the vendor URL.

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