Seconded, although I don't see much need for examples in this case. Bob -- _ |_) _ |_ Robert D. Hilliard <[EMAIL PROTECTED]> |_) (_) |_) Palm City, FL USA PGP Key ID: A8E40EB9
Anthony Towns <aj@azure.humbug.org.au> writes: > > --FLPM4o+7JoHGki3m > Content-Type: text/plain; charset=us-ascii > Content-Transfer-Encoding: quoted-printable > > On Fri, Dec 03, 1999 at 07:29:20PM -0800, Joey Hess wrote: > > A proposal for README.Debian (#42554) > > * Old. > > * Proposed by Stephane Bortzmeyer; seconded by Anthony Towns and > > Richard Braakman. > > * Policy doesn't talk about README.Debian right now. This is an > > addtion to policy that says what should be in the file. It says it > > should include descriptions of changes made to the upstream > > source, what options were enabled in configure and make, and the > > packages needed to build the package. > > What do people think of: > > --- - Wed Dec 8 22:11:23 1999 > +++ policy.text Wed Dec 8 22:11:11 1999 > @@ -2518,10 +2518,9 @@ > compressed nor be a symbolic link. > > In addition, the copyright file must say where the upstream sources > - (if any) were obtained, and explain briefly what modifications were > - made in the Debian version of the package compared to the upstream > - one. It must name the original authors of the package and the Debian > - maintainer(s) who were involved with its creation. > + (if any) were obtained, and it must name the original authors of > + the package and the Debian maintainer(s) who were involved with > + its creation. > > /usr/share/doc/<package-name> may be a symbolic link to a directory in > /usr/share/doc only if two packages both come from the same source and > @@ -2550,11 +2549,13 @@ > after all, the GPL does not "document" anything, it is merely a > license. > > - Do not use the copyright file as a general `README' file. If your > - package has such a file it should be installed in > - `/usr/share/doc/<package>/README' or `README.Debian' or some other > - appropriate place. > +6.6. Debian-specific Documentation > +---------------------------------- > > + A package may contain a file /usr/share/doc/<package>/README.Debian > + (or README.Debian.gz). This should be used to document any > + Debian-specific modifications made to the package, any compilation > + options that have been set, and any other user-visible changes. > > 6.7. Examples > ------------- > > ? > > Cheers, > aj