retitle 250202 [AMENDMENT 20/09/2004] "debian/README.source" file for packages with non-trivial source
thanks
It's been a while since the last mail on this proposal, which reached
the required number of seconders ages ago. I'm assuming the proposal has
been accepted now, and turn this into an amendment. For reference, the
patch as it should be applied is as follows:
--- policy.sgml.orig 2004-09-20 02:35:38.000000000 +0200
+++ policy.sgml 2004-09-20 02:38:37.000000000 +0200
@@ -2097,7 +2097,34 @@
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 should 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 are encouraged to include a README.source
+ file if the layout of the package is not trivial, so as to aid
+ understanding of it, even if the above condition is not
+ fulfilled.</p>
+ </sect>
</chapt>
--
EARTH
smog | bricks
AIR -- mud -- FIRE
soda water | tequila
WATER
-- with thanks to fortune
Attachment:
signature.asc
Description: Digital signature