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

Bug#250202: mandate a common name for "patched source" and/or "unpacked source"



On Thu, Jun 03, 2004 at 08:57:05AM +0200, Wouter Verhelst wrote:
> --- policy.sgml.orig	2004-06-03 08:48:43.000000000 +0200
> +++ policy.sgml	2004-06-03 08:55:59.000000000 +0200
> @@ -2105,7 +2105,33 @@
>  	  and <prgn>dpkg-distaddfile</prgn> should be called to add
>  	  the file to the list in <file>debian/files</file>.</p>
>        </sect>
> -
> +      
> +      <sect id="readmesource">
> +	<heading>Source package handling: debian/README.source</heading>
> +
> +	<p>
> +          When running <prgn>dpkg-source -x</prgn> does not
> +          immediately give one a directory with editable source, a
> +          package must provide a file debian/README.source which
> +          enumerates and documents the debian/rules targets for at
> +          least <em>unpacking the source</em> and <em>applying
> +          debian-specific patches</em> (if any, or a simple statement
> +          that such a target does not exist or is not required if
> +          none).</p>
> +
> +	<p>
> +          At the maintainer's option, the file may also document any
> +          other bits of the source package that may be of interest to
> +          someone unfamiliar with the package (although not
> +          necessarily with the upstream source), interested in making
> +          modifications to it.</p>
> +
> +	<p>
> +          Although this file is only required in one specific case
> +          (see above), maintainers may include a README.source file if
> +          they deem it appropriate, even if the above condition is not
> +          fulfilled.</p>
> +      </sect>
>      </chapt>

I second this proposal.

I used to put the README.source in ./, but I agree that if policy mandate
it, it should be in debian/

Cheers,
-- 
Bill. <ballombe@debian.org>

Imagine a large red swirl here. 

Attachment: pgpd01t2ACLJz.pgp
Description: PGP signature


Reply to: