Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 6978

Summary: kde eclass improvement
Product: Gentoo Linux Reporter: Maurizio Disimino <kevin>
Component: [OLD] KDEAssignee: Dan Armak (RETIRED) <danarmak>
Status: RESOLVED FIXED    
Severity: enhancement    
Priority: High    
Version: 1.0   
Hardware: x86   
OS: Linux   
Whiteboard:
Package list:
Runtime testing required: ---

Description Maurizio Disimino 2002-08-24 08:24:24 UTC
x11-themes/mosfet-liquid-widgets uses the kde eclass.
Since the kde eclass is meant for many and many ebuilds,
it has a 'dodoc' statement:

<snip>
          dodoc)
                                debug-print-section dodoc
                                dodoc AUTHORS ChangeLog README* COPYING NEWS TODO
                                ;;
</snip>

Btw, mosfet-liquid-widgets (maybe other ebuilds?) doesn't
have README, AUTHORS, etc..

So .. here's the output we get:
[...]
make[2]: Leaving directory
`/var/tmp/portage/mosfet-liquid-widgets-0.9.5/work/mosfet-liquid0.9.5'
make[1]: Leaving directory
`/var/tmp/portage/mosfet-liquid-widgets-0.9.5/work/mosfet-liquid0.9.5'
/usr/lib/portage/bin/dodoc: AUTHORS does not exist.
/usr/lib/portage/bin/dodoc: ChangeLog does not exist.
/usr/lib/portage/bin/dodoc: README* does not exist.
/usr/lib/portage/bin/dodoc: COPYING does not exist.
/usr/lib/portage/bin/dodoc: NEWS does not exist.
/usr/lib/portage/bin/dodoc: TODO does not exist.
strip:
/var/tmp/portage/mosfet-liquid-widgets-0.9.5/image/usr/lib/libkcm_liquid.so
[...]

This is a "normal" output since the 'dodoc' code already provides 
a check.

<snip>
if [ -e ${x} ]
then
[.....]
else
        echo "${0}: ${x} does not exist."
        fi
</snip>

Btw, we could avoid this output by adding a double check in the kde eclass.
for instance:

for i in AUTHORS ChangeLog README* COPYING NEWS TODO; do [ -e ${i} ] && dodoc
${i}; done

I'm aware this will have low priority, so I'm marking this bug as "enhancement".
Thanks :)
Comment 1 Dan Armak (RETIRED) gentoo-dev 2002-08-31 14:38:26 UTC
I'll add this soon as I have a few free moments... 
Comment 2 Maurizio Disimino 2002-09-08 08:57:18 UTC
another solution would be the one adopted by the gnome guys 
that I've just noticed.
from gnome2.eclass:

gnome2_src_install() {
[.....]
        # manual document installation
        if [ -n "${DOCS}" ]
        then
                dodoc ${DOCS}
        fi
[.....]
}

and then they simply define the DOCS="README NEWS whatever" variable in
the various ebuild.
Comment 3 Dan Armak (RETIRED) gentoo-dev 2002-09-10 04:34:56 UTC
No, that would destroy the whole idea of automatically getting whatever docs  are available without the ebuild doing anything about it explicitly.    I've implemented the original solution, committing in a few minutes from now. Sorry this took so long...