Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 83779 - Important docs overwritten in mail-filter/dspam
Summary: Important docs overwritten in mail-filter/dspam
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All All
: High normal (vote)
Assignee: Lim Swee Tat (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-03-02 00:46 UTC by Mike Nerone
Modified: 2005-03-21 01:03 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
Patch for dspam-3.4_rc2.ebuild (dspam-3.4_rc2.ebuild.patch,999 bytes, patch)
2005-03-02 00:48 UTC, Mike Nerone
Details | Diff
New patch for dspam-3.4_rc2.ebuild (dspam-3.4_rc2.ebuild.patch,1.07 KB, patch)
2005-03-02 01:08 UTC, Mike Nerone
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Mike Nerone 2005-03-02 00:46:41 UTC
Note that I'm looking at mail-filter/dspam-3.4_rc2, but at a glance it looks like this applies to all ebuilds currently in the tree.

Basically, there are some big problems with the dodocs:

  1. Things like "dodoc src/tools.mysql_drv/README" overwrite the *main* README. Big no-no.
  2. "dodoc ${FILESDIR}/README.postfix ${FILESDIR}/README.qmail" overwrites files with the same names provided by upstream. In the case of README.postfix, a set of useful and detailed instructions is overwritten by what I can only describe as a five-line stream-of-consciousness quasi-haiku. :P
  3. The file "UPGRADING" is left out, but contains important info for many users. In any case, upstream docs should be provided, IMHO.
Comment 1 Mike Nerone 2005-03-02 00:48:21 UTC
Created attachment 52436 [details, diff]
Patch for dspam-3.4_rc2.ebuild

Here is a patch for dspam-3.4_rc2.ebuild that fixes all of these problems.

Note 1: in FILESDIR, README.* should also be renamed to README.gentoo.* (is the
README.postfix haiku even useful to anybody???). Changing the corresponding
dodoc lines in the older, stable ebuilds is so trivial that it's ok to do so
with care, IMHO. If you disagree, just copy the files to the new names instead.
Then the old names can eventually go away when the old ebuilds are purged from
the tree.

Note 2: I've preserved the behavior of only installing the README.<backend>_drv
indicated by USE, but you might consider just including all of the
upstream-provided docs.
Comment 2 Mike Nerone 2005-03-02 01:08:23 UTC
Created attachment 52437 [details, diff]
New patch for dspam-3.4_rc2.ebuild

On second thought, I think it should be made clearer that the READMEs from
FILESDIR are provided by gentoo, and not upstream. This patch makes the ebuild
put them in a "gentoo" subdirectory instead. Happily, this also makes it
unnecessary to rename them at all. :)
Comment 3 Lim Swee Tat (RETIRED) gentoo-dev 2005-03-08 23:07:25 UTC
Hi,
  Thank you very much for this help. :)  I'm glad someone caught something I missed all this while. :)

Ciao
ST Lim
Comment 4 Mike Nerone 2005-03-21 01:03:14 UTC
For anyone reading this later, this comes up again in bug #86099.