Browse Source

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.
Guillem Jover 7 years ago
parent
commit
6db5b664cd
2 changed files with 23 additions and 12 deletions
  1. 3 0
      debian/changelog
  2. 20 12
      man/deb-src-control.5

+ 3 - 0
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.

+ 20 - 12
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