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

Re: Bug#758124: Documenting the Testsuite field in the Policy.



On Wed, Aug 20, 2014 at 01:38:32PM +0200, Andreas Tille wrote:
> On Tue, Aug 19, 2014 at 07:35:22PM -0300, Antonio Terceiro wrote:
> > > 
> > > Anybody Developer who thinks that 1) the Policy is useful and 2) the Testsuite
> > > field is useful, can participate.  What is needed is to read the text below, 
> > > verify that it reflects the facts, and if yes, send an email containing
> > > something like “seconded”.
> > 
> > IMO the fact that close to 600 packages are already using the field
> > shows quite some support for it to be documented. :)
> 
> I somehow was guided by this idea when I was raising my hand the first
> time.  And yes, I agree that we should document what we are using.
> 
> > > > > > +	  <heading><tt>Testsuite</tt></heading>
> > > > > > +
> > > > > > +	  <p>
> > > > > > +	    Simple field containing a comma-separated list of values allowing
> > > > > > +	    test execution environments to discover packages which provide
> > > > > > +	    tests.  Currently, the only defined value is <tt>autopkgtest</tt>.
> > > > > > +	  </p>
> > > > > > +
> > > > > > +	  <p>
> > > > > > +	    This field is automatically added to Debian source control files by
> > > > > > +	    <prgn>dpkg</prgn><footnote>from version 1.17.11.</footnote> when
> > > > > > +	    a <file>debian/tests/control</file> file is present in the source
> > > > > > +	    package.  This field may also be used in source package control
> > > > > > +	    files if needed in other situations.
> > > > > > +	  </p>
> > 
> > Looks good to me. Seconded, FWIW.
> 
> I wonder whether the second paragraph implies something like: "Since the
> field is automatically added there is no reason to specify it explicitly
> any more."  I think this policy change is even implemented in lintian since
> I think to remember that lintian stopped warning about the missing testsuite
> field (if I remember correctly without checking).

There are cases when you want to add it explicitly, e.g. when someone
comes up with a new possible value for it that is not automatically
added yet.

Testsuite: mynewthing

or even

Testsuite: autopkgtest, mynewthing

So maybe we could review the text like this:

<heading><tt>Testsuite</tt></heading>

<p>
  Simple field containing a comma-separated list of values allowing
  test execution environments to discover packages which provide
  tests.  Currently, the only defined value is <tt>autopkgtest</tt>.
</p>

<p>
  <prgn>dpkg-source</prgn><footnote>from <prgn>dpkg-dev</prgn> version
  1.17.11.</footnote> will automatically add this field to Debian source
  control files with the value <tt>autopkgtest</tt> if a
  <file>debian/tests/control</file> file is present in the source
  package. This field may also be used in source package control files
  if needed in other situations, for example to declare other test suite
  handlers that are not yet automatically detected by dpkg.
</p>

-- 
Antonio Terceiro <terceiro@debian.org>

Attachment: signature.asc
Description: Digital signature


Reply to: