retitle 250202 [PROPOSAL] mandate a "debian/README.source" file for packages with non-trivial source
thanks
On Fri, May 21, 2004 at 12:56:45PM +0200, Wouter Verhelst wrote:
> On Fri, May 21, 2004 at 12:11:42PM +0200, Bill Allombert wrote:
> > On Fri, May 21, 2004 at 11:27:27AM +0200, Wouter Verhelst wrote:
> > > Wouldn't it be a good idea to add two targets to the debian/rules file,
> > > say, "unpacked" and "patched" or something[1], which would unpack the
> > > source, resp. patch it using the provided patches? These targets would
> > > be mandatory if an unpacked source package would not provide an unpacked
> > > source tree, and optional otherwise.
> >
> > I would prefer if they do not require to run such target in the first
> > place. There is no need for it, you can just ship the patches preapplied
> > (with dpatch, it is just a matter of making clean depend of patch
> > instead of unpatch).
>
> While, in principle, I have nothing against this, it would make a huge
> number of packages InstaBuggy, which clearly is not the way to go.
>
> > I heard that doogie is developing a new release of dbs that would not
> > require to run such target anymore.
> >
> > Also all my packages with non-trivial source process include a file
> > ./README.source that explain how source should be handled.
>
> Hm. That sounds like a good idea, too.
Since I got no further replies, let me fix it up to a formal proposal.
I propose that the following paragraph be added to the current Debian
policy. I'm looking for seconds.
--- 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>
--
EARTH
smog | bricks
AIR -- mud -- FIRE
soda water | tequila
WATER
-- with thanks to fortune
Attachment:
signature.asc
Description: Digital signature