[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#547272: Clarification of the Format field in control files



On 22/06/10 19:26, Russ Allbery wrote:
> Charles, are you happy with those changes?  Everyone else, objections or
> seconds?
> 
> diff --git a/policy.sgml b/policy.sgml
> index d489738..77850d6 100644
> --- a/policy.sgml
> +++ b/policy.sgml
> @@ -2595,15 +2595,21 @@ Package: libc6
>  	<heading>Debian changes files -- <file>.changes</file></heading>
>  
>  	<p>
> -	  The .changes files are used by the Debian archive maintenance
> -	  software to process updates to packages. They contain one
> -	  paragraph which contains information from the
> +	  The <file>.changes</file> files are used by the Debian archive
> +	  maintenance software to process updates to packages. They
> +	  contain one paragraph which contains information from the
>  	  <tt>debian/control</tt> file and other data about the
>  	  source package gathered via <tt>debian/changelog</tt>
>  	  and <tt>debian/rules</tt>.
>  	</p>
>  
>  	<p>
> +	  <file>.changes</file> files have a format version that is
> +	  incremented whenever the documented fields or their meaning
> +	  change.  This document describes format 1.8.
> +	</p>
> +
> +	<p>
>  	  The fields in this file are:
>  
>  	  <list compact="compact">
> @@ -3259,12 +3265,29 @@ Package: libc6
>  	  <heading><tt>Format</tt></heading>
>  
>  	  <p>
> -	    This field specifies a format revision for the file.
> -	    The most current format described in the Policy Manual
> -	    is version <strong>1.5</strong>.  The syntax of the
> -	    format value is the same as that of a package version
> -	    number except that no epoch or Debian revision is allowed
> -	    - see <ref id="f-Version">.
> +	    In <qref id="debianchangesfiles"><file>.changes</file></qref>
> +	    files, this field declares the format version of that file.
> +	    The syntax of the field value is the same as that of
> +	    a <qref id="f-Version">package version number</qref> except
> +	    that no epoch or Debian revision is allowed.  The format
> +	    described in this document is <tt>1.8</tt>.
> +	  </p>
> +
> +	  <p>
> +	    In <qref id="debiansourcecontrolfiles"> Debian source
> +	    control</qref> files, this field declares the format of the

In the other paragraph, you say "In .changes files", maybe you should also say
"In .dsc files" here (or the other way round)?

> +	    source package.  The field value is used by programs acting on
> +	    a source package to interpret the list of files in the source
> +	    package and determine how to unpack it.  The syntax of the
> +	    field value is a numeric major revision, a period, a numeric
> +	    minor revision, and then an optional subtype after whitespace,
> +	    which if specified is an alphanumeric word in parentheses.
> +	    The subtype is optional in the syntax but may be mandatory for
> +	    particular source format revisions.<footnote>
> +	      The source formats currently supported by the Debian archive
> +	      software are <tt>1.0</tt>, <tt>3.0 (native)</tt>,
> +	      and <tt>3.0 (quilt)</tt>.
> +	    </footnote>
>  	  </p>
>  	</sect1>
>  
> @@ -3525,7 +3548,6 @@ Checksums-Sha256:
>  	    must match the list of files in the <tt>Files</tt> field.
>  	  </p>
>  	</sect1>
> -
>        </sect>
>  
>        <sect>
> 

Seconded, with and without a change for my comment above.

Emilio

Attachment: signature.asc
Description: OpenPGP digital signature


Reply to: