Browse Source

man: Document missing fields

Add information about the Install-Size, Built-For-Profiles and
Build-Profiles fields.
Guillem Jover 10 years ago
parent
commit
38ac205718
3 changed files with 27 additions and 0 deletions
  1. 2 0
      debian/changelog
  2. 10 0
      man/deb-control.5
  3. 15 0
      man/deb-src-control.5

+ 2 - 0
debian/changelog

@@ -4,6 +4,8 @@ dpkg (1.18.5) UNRELEASED; urgency=medium
     - Say value instead of option in deb-control(5).
     - Mark debian changelog format in bold in dpkg-parsechangelog(1).
     - Add references to man pages describing file formats.
+    - Document missing Install-Size, Built-For-Profiles and Build-Profiles
+      fields in man pages.
 
  -- Guillem Jover <guillem@debian.org>  Fri, 25 Dec 2015 14:20:16 +0100
 

+ 10 - 0
man/deb-control.5

@@ -88,6 +88,11 @@ fields have a defined set of accepted values based on the Policy Manual.
 A list of these values can be obtained from the latest version of the
 .B debian\-policy
 package.
+.
+.TP
+.BR Installed\-Size: " size"
+The approximate total size of the package's installed files, in KiB units.
+.
 .TP
 .BR Essential: " \fByes\fP|\fBno\fP"
 This field is usually only needed when the answer is \fByes\fP. It denotes
@@ -298,6 +303,11 @@ refuse to accept an upload which declares a
 .B Built\-Using
 relationship which cannot be satisfied within the archive.
 .
+.TP
+.BI Built\-For\-Profiles: " profile-list"
+This field specifies a whitespace separated list of build profiles that this
+binary packages was built with.
+.
 .SH EXAMPLE
 .\" .RS
 .nf

+ 15 - 0
man/deb-src-control.5

@@ -277,6 +277,21 @@ architecture wildcards in that list (see
 .BR dpkg\-architecture (1)
 for more information about them).
 
+.TP
+.BR Build\-Profiles: " \fIrestriction-formula\fP"
+This field specifies the conditions for which this binary package does or
+does not build.
+To express that condition, the same restriction formula syntax from the
+\fBBuild\-Depends\fP field is used.
+
+If a binary package paragraph does not contain this field, then it implicitly
+means that it builds with all build profiles (including none at all).
+
+In other words, if a binary package paragraph is annotated with a non-empty
+\fBBuild\-Profiles\fP field, then this binary package is generated if and
+only if the condition expressed by the conjunctive normal form expression
+evaluates to true.
+
 .TP
 .BR Package\-Type: " \fBdeb\fP|\fBudeb\fP"
 This field defines the type of the package.