Re: [gentoo-dev] prepalldocs implementation in eutils.eclass (was: prepalldocs is now banned)

[Tiziano Müller]

Am Mittwoch, den 18.02.2009, 03:22 -0500 schrieb Michael Sterrett:
> Patches welcome.
>
> On Wed, Feb 18, 2009 at 3:13 AM, Torsten Veller <ml-en@××××××.net> wrote:
> > * Michael Sterrett <mr_bones_@g.o>:
> >> I added a prepalldocs function to eutils.eclass to provide the
> >> functionality.  It implements the
> >> behavior of the current stable sys-apps/portage-2.1.6.4.
> >
> > ecompressdir is more portage internal than prepalldocs ever was.
> > This must be fixed.
> >
> >
Instead of breaking things you could have tried to come up with a real
solution.

Even though I share the opinion that compressing docs is unnecessary I
started looking through the use cases.
I'm not done yet, but I think I already identified a couple of common
cases:

[1]
src_install() {
  emake DESTDIR="${D}" docdir="/usr/share/doc/${PF}"
  prepalldocs
}
(or similar)
will change to:
src_install() {
  emake DESTDIR="${D}" docdir="${T}/doc"
  dodoc "${T}/doc"
}

[2]
Not needed at all since every doc gets installed using dodoc or newdoc

[3]
Package installs doc to wrong location.
Solution: dodoc <OLDLOCATION>/* ; rm -rf <OLDLOCATION>

[4]
Assuming that "make install" installs something in /usr/share/doc/${PF}.
Assumption is wrong since "make install" will install
to /usr/share/doc/${P} if at all (since the package doesn't know
anything about -rX). So it should be changed anyway and then case [1] or
[3] applies.

Example packages for case [1]: app-arch/gtk-splitter, app-cdr/cdcover,
app-crypt/steghide, app-editors/lpe, app-emacs/ess
Example packages for case [2]: app-arch/rar, app-backup/amanda
Example packages for case [3]: app-crypt/gnupg
Example packages for case [4]: app-arch/xdms, app-crypt/gnupg-pkcs11-scd

The only problem I see here is that either <OLDLOCATION> or ${T}/doc
contains subdirs. So my proposal for the next EAPI is to allow dodoc and
newdoc to operate on dirs. Which also gives the benefit to reduce this
idiom:
  insinto /usr/share/doc/${PF}
  doins -r examples
to:
  dodoc examples


Your comments?

Cheers,
Tiziano 



-- 
-------------------------------------------------------
Tiziano Müller
Gentoo Linux Developer, Council Member
Areas of responsibility:
  Samba, PostgreSQL, CPP, Python, sysadmin
E-Mail     : dev-zero@g.o
GnuPG FP   : F327 283A E769 2E36 18D5  4DE2 1B05 6A63 AE9C 1E30