[dpkg] 42/187: man: Improve user-defined field export marker documentation

[Reiner Herrmann]

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

deki-guest pushed a commit to branch master
in repository dpkg.

commit 6db5b664cd164a553c6c7d2960cc93e83a5ef689
Author: Guillem Jover <guillem at debian.org>
Date:   Mon Oct 3 04:11:47 2016 +0200

    man: Improve user-defined field export marker documentation
    
    Mention that X can be followed by zero or more (instead of one or more)
    letters. Turn the items into a proper list.
---
 debian/changelog      |  3 +++
 man/deb-src-control.5 | 32 ++++++++++++++++++++------------
 2 files changed, 23 insertions(+), 12 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 46c3ad7..d02b6a1 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -20,6 +20,9 @@ dpkg (1.18.11) UNRELEASED; urgency=medium
     - Itemize --log format entries in dpkg(1).
     - Turn the update-alternatives(1) --query example item into a sub-section.
     - Turn the Multi-Arch values into a list in deb-control(5).
+    - Improve user-defined field export marker documentation in
+      deb-src-control(5); clarify that X can be followed by zero or more
+      (instead of one or more) letters and turn the items into a proper list.
   * Build system:
     - Add support for profiling perl modules.
     - Clean up compiler and linker automatic flag usage in configure.
diff --git a/man/deb-src-control.5 b/man/deb-src-control.5
index e4d7aa8..11d1b9d 100644
--- a/man/deb-src-control.5
+++ b/man/deb-src-control.5
@@ -350,18 +350,26 @@ manpage.
 It is allowed to add additional user-defined fields to the control file. The
 tools will ignore these fields. If you want the fields to be copied over to
 the output files, such as the binary packages, you need to use a custom naming
-scheme: the fields should start with an X, followed by one or more of the
-letters BCS and a hyphen.
-If the letter B is used, the field will appear in the
-control file in the binary package, see
-.BR deb\-control (5),
-for the letter S in the source package control file as constructed by
-.BR dpkg\-source (1)
-and for the letter C in the upload control (.changes) file. Note that the
-X[BCS]\- prefixes are stripped when the fields are copied over to the
-output files. A field \fBXC\-Approved\-By\fP will appear as
-\fBApproved\-By\fP in the changes file and will not appear in the binary or
-source package control files.
+scheme: the fields should start with an \fBX\fP, followed by zero or more of
+the letters \fBBCS\fP and a hyphen.
+
+.TP
+.B B
+The field will appear in the control file in the binary package, see
+\fBdeb\-control\fP(5).
+.TP
+.B S
+The field will appear in the source package control file, see \fBdsc\fP(5).
+.TP
+.B C
+The field will appear in the upload control (.changes) file, see
+\fBdeb\-changes\fP(5).
+
+.P
+Note that the \fBX\fP[\fBBCS\fP]\fB\-\fP prefixes are stripped when the
+fields are copied over to the output files. A field \fBXC\-Approved\-By\fP
+will appear as \fBApproved\-By\fP in the changes file and will not appear
+in the binary or source package control files.
 
 Take into account that these user-defined fields will be using the global
 namespace, which might at some point in the future collide with officially

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