Przeglądaj źródła

man: Update field requirements of control file formats to match dpkg reality

Document all fields that are just recommended instead of required, or
simply add if they are recommended and did not mention the fact before.
Guillem Jover 10 lat temu
rodzic
commit
27dc82138d
5 zmienionych plików z 11 dodań i 10 usunięć
  1. 1 0
      debian/changelog
  2. 2 2
      man/deb-changes.5
  3. 3 3
      man/deb-control.5
  4. 2 2
      man/deb-src-control.5
  5. 3 3
      man/dsc.5

+ 1 - 0
debian/changelog

@@ -92,6 +92,7 @@ dpkg (1.18.5) UNRELEASED; urgency=medium
     - Clarify that deb-symbols(5) documents the binary format subset, and
       the template symbol files are described in dpkg-gensymbols(1).
       Closes: #795163
+    - Update field requirements of control file formats to match dpkg reality.
 
   [ Updated programs translations ]
   * Portuguese (Miguel Figueiredo).

+ 2 - 2
man/deb-changes.5

@@ -92,7 +92,7 @@ The exact format and sorting algorithm are described in
 Lists one or more space-separated distributions where this version should
 be installed when it is uploaded to the archive.
 .TP
-.BR Urgency: " \fIurgency\fP"
+.BR Urgency: " \fIurgency\fP (recommended)"
 The urgency of the upload.
 The currently known values, in increasing order of urgency, are:
 .BR low ", " medium ", " high ", " critical " and " emergency .
@@ -106,7 +106,7 @@ the software that was packaged.
 Should be in the format \(lqJoe Bloggs <jbloggs@example.org>\(rq, and is
 typically the person who prepared the package changes for this release.
 .TP
-.BR Description: " (required)"
+.BR Description: " (recommended)"
 .TQ
 .RB " \fIbinary-package-name\fP " \fB\-\fP " \fIbinary-package-summary\fP"
 This multiline field contains a list of binary package names followed by

+ 3 - 3
man/deb-control.5

@@ -54,12 +54,12 @@ the program's author uses. It may also include a Debian revision number
 are described in
 .BR deb\-version (5).
 .TP
-.BR Maintainer: " \fIfullname-email\fP (required)"
+.BR Maintainer: " \fIfullname-email\fP (recommended)"
 Should be in the format \(lqJoe Bloggs <jbloggs@foo.com>\(rq, and is typically
 the person who created the package, as opposed to the author of the
 software that was packaged.
 .TP
-.BR Description: " \fIshort-description\fP (required)"
+.BR Description: " \fIshort-description\fP (recommended)"
 .TQ
 .BI " " "long-description"
 .br
@@ -104,7 +104,7 @@ This field is usually only needed when the answer is \fByes\fP, and is
 commonly injected by the archive software.
 It denotes a package that is required when building other packages.
 .TP
-.BR Architecture: " \fIarch\fP|\fBall\fP"
+.BR Architecture: " \fIarch\fP|\fBall\fP (recommended)"
 The architecture specifies which type of hardware this package was compiled
 for.
 Common architectures are \fBamd64\fP, \fBarmel\fP, \fBi386\fP, \fBpowerpc\fP,

+ 2 - 2
man/deb-src-control.5

@@ -54,7 +54,7 @@ minus (-) signs, and periods (.). Package names must be at least two characters
 long and must start with an alphanumeric character.
 
 .TP
-.BR Maintainer: " \fIfullname-email\fP (required)"
+.BR Maintainer: " \fIfullname-email\fP (recommended)"
 Should be in the format \(FoJoe Bloggs <jbloggs@foo.com>\(Fc, and references the
 person who currently maintains the package, as opposed to the author of the
 software or the original packager.
@@ -315,7 +315,7 @@ package for more details about them.
 .TQ
 .BI Tag: " tag-list"
 .TQ
-.BR Description: " \fIshort-description\fP (required)"
+.BR Description: " \fIshort-description\fP (recommended)"
 These fields are described in the
 .BR deb\-control (5)
 manual page, as they are copied literally to the control file of the binary

+ 3 - 3
man/dsc.5

@@ -70,7 +70,7 @@ This field has now been superseded by the \fBPackage\-List\fP field, which
 gives enough information about what binary packages are produced on which
 architecture, build-profile and other involved restrictions.
 .TP
-.BR Architecture: " \fIarch-list\fP"
+.BR Architecture: " \fIarch-list\fP (recommended)"
 A list of architectures and architecture wildcards separated by spaces
 which specify the type of hardware this package can be compiled for.
 Common architecture names and architecture wildcards are \fBamd64\fP,
@@ -95,7 +95,7 @@ The exact format and sorting algorithm are described in
 .BI Origin: " name"
 The name of the distribution this package is originating from.
 .TP
-.BR Maintainer: " \fIfullname-email\fP (required)"
+.BR Maintainer: " \fIfullname-email\fP (recommended)"
 Should be in the format \(lqJoe Bloggs <jbloggs@foo.com>\(rq, and is
 typically the person who created the package, as opposed to the author
 of the software that was packaged.
@@ -108,7 +108,7 @@ Multiple co-maintainers should be separated by a comma.
 .BI Homepage: " url"
 The upstream project home page \fIurl\fP.
 .TP
-.BI Standards\-Version:
+.BI Standards\-Version: " (recommended)"
 This documents the most recent version of the distribution policy standards
 this package complies with.
 .TP