Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 298153 - x11-wm/fvwm: documentation installed outside /usr/share/doc/${PF}
Summary: x11-wm/fvwm: documentation installed outside /usr/share/doc/${PF}
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High minor (vote)
Assignee: Jesús Guerrero Botella (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-12-23 23:43 UTC by Diego Elio Pettenò (RETIRED)
Modified: 2010-10-27 13:18 UTC (History)
2 users (show)

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


Attachments
Patch to remove docdir cruft (docdir.diff,3.03 KB, patch)
2010-05-10 16:56 UTC, Jesús Guerrero Botella (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Diego Elio Pettenò (RETIRED) gentoo-dev 2009-12-23 23:43:17 UTC
You're getting this bug because the package in summary installs its documentation (or at least part of it) outside the usual /usr/share/doc/${PF} directory.

First, please keep in mind that this bug might not be noticeable for -r0 ebuilds, but it might be for -r1 and later, since if the ebuild has same name and version of the package, for -r0 it might correspond properly.

To fix this, if the package uses autotools, recent version (autoconf 2.61+) have two ./configure switches: --docdir and --htmldir to decide where to put the documentation. Older versions might require you override docdir/htmldir or other custom variables during make install.

For non-autotooled build systems, good luck, since I cannot tell you how to achieve the proper results, the same holds true with totally broken buildsystems even when based on autotools.

Thanks,
Diego
Comment 1 Jesús Guerrero Botella (RETIRED) gentoo-dev 2009-12-24 13:10:34 UTC
Thanks for the report. I am testing the proposed solution and will submit the ebuild as soon as possible.
Comment 2 Jesús Guerrero Botella (RETIRED) gentoo-dev 2009-12-24 14:01:26 UTC
Now the docs seem to go correctly into the right directory, however, the ebuild still creates some empty dirs at an alternate location. This will take some time to debug because I am not familiar with autotools. 

This is the file list for me (ignore the ebuild version since this can be easily backported):

/usr/share/doc/fvwm/
/usr/share/doc/fvwm/commands/
/usr/share/doc/fvwm/images/
/usr/share/doc/fvwm/images/svg_rendering/
/usr/share/doc/fvwm/modules/
/usr/share/doc/fvwm/modules/images/
/usr/share/doc/fvwm/modules/images/FvwmTabs/
/usr/share/doc/fvwm/fvwm/
/usr/share/doc/fvwm-9999-r1/
/usr/share/doc/fvwm-9999-r1/NEWS.bz2
/usr/share/doc/fvwm-9999-r1/README.bz2
/usr/share/doc/fvwm-9999-r1/BUGS.bz2
/usr/share/doc/fvwm-9999-r1/FAQ.bz2
/usr/share/doc/fvwm-9999-r1/TODO.bz2
/usr/share/doc/fvwm-9999-r1/fvwm.lsm.bz2
/usr/share/doc/fvwm-9999-r1/AUTHORS.bz2
/usr/share/doc/fvwm-9999-r1/ChangeLog.bz2
/usr/share/doc/fvwm-9999-r1/ANNOUNCE.bz2
/usr/share/doc/fvwm-9999-r1/COMMANDS.bz2
/usr/share/doc/fvwm-9999-r1/CONVENTIONS.bz2
/usr/share/doc/fvwm-9999-r1/DEVELOPERS.bz2
/usr/share/doc/fvwm-9999-r1/error_codes.bz2
/usr/share/doc/fvwm-9999-r1/README.translucency.bz2

Everything is going into /usr/share/doc/fvwm-9999-r1/ however it still creates a number of subdirs at /usr/share/doc/fvwm/, all of which are empty. I guess this is one of these broken configure scripts that you speak of. Suggestions on how to debug this are welcome.
Comment 3 Jeremy Olexa (darkside) (RETIRED) archtester gentoo-dev Security 2009-12-24 17:06:08 UTC
(In reply to comment #2)

> Everything is going into /usr/share/doc/fvwm-9999-r1/ however it still creates
> a number of subdirs at /usr/share/doc/fvwm/, all of which are empty. I guess
> this is one of these broken configure scripts that you speak of. Suggestions on
> how to debug this are welcome.
> 

In src_install, rm -rf ${D}/<empty dir> is one way.
Comment 4 Kevin Pyle 2009-12-24 19:42:00 UTC
Based on the names of the empty directories, one of them is probably coming from doc/modules/images/FvwmTabs/Makefile.am.  Inspection there reveals that docdir is explicitly assigned a value derived from FVWM_DOCDIR.  FVWM_DOCDIR is set in configure.ac as '${datadir}'"$FVWM_DOCSUBDIR".  FVWM_DOCSUBDIR is set as /doc/${PACKAGE}.  This should result in FVWM_DOCDIR being assigned /usr/share/doc/fvwm.

As I read the automake-generated doc/modules/images/FvwmTabs/Makefile.in shipped in the tarball, docdir will be made whether or not it has anything in it.  Look around line 322.  Removing the explicit assignment of docdir from the .am files might fix the empty directories, and is worthwhile anyway, since its value is inconsistent with the directory that this bug requests.
Comment 5 Jesús Guerrero Botella (RETIRED) gentoo-dev 2009-12-25 19:27:43 UTC
(In reply to comment #3)
> (In reply to comment #2)
> 
> > Everything is going into /usr/share/doc/fvwm-9999-r1/ however it still creates
> > a number of subdirs at /usr/share/doc/fvwm/, all of which are empty. I guess
> > this is one of these broken configure scripts that you speak of. Suggestions on
> > how to debug this are welcome.
> > 
> 
> In src_install, rm -rf ${D}/<empty dir> is one way.
> 

I thought of that, however that's only circumventing the real problem. I will look into it again using the advice from Kevin Pyle and possibly discuss an upstream fix on the fvwm list, if the problem is truly on their make files, tomorrow if possible, I am really busy today.

Thanks everyone for all the info, it's greatly appreciated and very helpful indeed.
Comment 6 Jesús Guerrero Botella (RETIRED) gentoo-dev 2010-05-10 16:56:24 UTC
Created attachment 230985 [details, diff]
Patch to remove docdir cruft

So I am back. 

I have managed to remove most of the cruft by following the advice above, however /usr/share/doc/fvwm still exists and I haven't been able to remove it.
Comment 7 Jeremy Olexa (darkside) (RETIRED) archtester gentoo-dev Security 2010-10-27 03:50:17 UTC
Did this ever get resolved in the latest version(s) ?
Comment 8 Jesús Guerrero Botella (RETIRED) gentoo-dev 2010-10-27 07:41:10 UTC
(In reply to comment #7)
> Did this ever get resolved in the latest version(s) ?
> 

In 2.5.31 with USE=doc I can't see a directory called /usr/share/doc/fvwm, only /usr/share/doc/fvwm-2.5.31 exists.
Comment 9 Jeremy Olexa (darkside) (RETIRED) archtester gentoo-dev Security 2010-10-27 13:18:33 UTC
thx. closing then