Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 164917 - x11-proto/damageproto-1.1.0: wrong doc directory
Summary: x11-proto/damageproto-1.1.0: wrong doc directory
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High trivial (vote)
Assignee: Gentoo X packagers
URL:
Whiteboard:
Keywords: Inclusion
: 169934 234488 241558 (view as bug list)
Depends on:
Blocks: 241568
  Show dependency tree
 
Reported: 2007-02-01 21:49 UTC by Ulrich Müller
Modified: 2009-12-07 17:57 UTC (History)
4 users (show)

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


Attachments
x-modular.eclass patch (x-modular-protodoc.patch,549 bytes, patch)
2007-09-10 18:48 UTC, Chris Mayo
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2007-02-01 21:49:20 UTC
x11-proto/damageproto-1.1.0 installs its documentation in /usr/share/doc/damageproto. It should be /usr/share/doc/damageproto-${PV} instead.
Comment 1 Jakub Moc (RETIRED) gentoo-dev 2007-02-02 08:19:48 UTC
(In reply to comment #0)
> It should be /usr/share/doc/damageproto-${PV} instead.

Better yet, /usr/share/doc/damageproto-${PF} :)

Comment 2 Donnie Berkholz (RETIRED) gentoo-dev 2007-02-02 18:05:16 UTC
We should do whatever's normal in autotools rather than hacking around in the ebuild. I haven't looked into it, so I don't know offhand whether versioned or not is typical.
Comment 3 Ulrich Müller gentoo-dev 2007-02-17 08:26:58 UTC
(In reply to comment #2)
> We should do whatever's normal in autotools rather than hacking around in the
> ebuild.

Hm, the Ebuild HOWTO in the dev handbook says the following:
# Documentation files are installed in /usr/share/doc, into a subdirectory
# reflecting the name, version, and revision of the particular program.
Comment 4 Joshua Baergen (RETIRED) gentoo-dev 2007-02-17 16:02:09 UTC
(In reply to comment #3)
> Hm, the Ebuild HOWTO in the dev handbook says the following:
> # Documentation files are installed in /usr/share/doc, into a subdirectory
> # reflecting the name, version, and revision of the particular program.
> 

Right, which usually applies to doc files installed explicitly by the ebuild.  In this case, the doc file is installed by autotools.  Unfortunately, this means that damageproto currently has two entries under /usr/share.

dia and libxcb are also guilty of this.  It's unclear to me what the correct solution is.  I'm not sure if our doc locations are specific to us or if many distributions use them.
Comment 5 Donnie Berkholz (RETIRED) gentoo-dev 2007-02-18 19:28:02 UTC
(In reply to comment #4)
> Right, which usually applies to doc files installed explicitly by the ebuild. 
> In this case, the doc file is installed by autotools.  Unfortunately, this
> means that damageproto currently has two entries under /usr/share.
> 
> dia and libxcb are also guilty of this.  It's unclear to me what the correct
> solution is.  I'm not sure if our doc locations are specific to us or if many
> distributions use them.

I suppose this happens because it both installs docs normally and via dodoc? We should probably change the doc dir with docinto().
Comment 6 Joshua Baergen (RETIRED) gentoo-dev 2007-02-18 19:34:36 UTC
(In reply to comment #5)
> I suppose this happens because it both installs docs normally and via dodoc? We
> should probably change the doc dir with docinto().
> 

Yes.  You mean we should change our install location to drop the version to match what upstream wants?
Comment 7 Donnie Berkholz (RETIRED) gentoo-dev 2007-02-18 19:56:48 UTC
(In reply to comment #6)
> Yes.  You mean we should change our install location to drop the version to
> match what upstream wants?

Yes. It's cleaner and easier than hacking around the build system when using x-modular.eclass, and the difference is only relevant for slotted packages, of which we have none.
Comment 8 Joshua Baergen (RETIRED) gentoo-dev 2007-02-19 01:25:42 UTC
(In reply to comment #7)
> Yes. It's cleaner and easier than hacking around the build system when using
> x-modular.eclass, and the difference is only relevant for slotted packages, of
> which we have none.

Alright.
Comment 9 Joshua Baergen (RETIRED) gentoo-dev 2007-02-19 22:25:44 UTC
Hmm, what do you think about doing this for all proto packages, since I'm sure many of the future packages will begin to do this?
Comment 10 Donnie Berkholz (RETIRED) gentoo-dev 2007-02-20 00:12:03 UTC
(In reply to comment #9)
> Hmm, what do you think about doing this for all proto packages, since I'm sure
> many of the future packages will begin to do this?

All the dodoc() calls are in the eclass, AFAIK. Changing it in there should take care of everything, and that's what I meant even if I didn't say it.
Comment 11 Donnie Berkholz (RETIRED) gentoo-dev 2007-04-19 02:22:00 UTC
Thought about this more. I agree that these should all get stuck in $PF, since that's what the Gentoo docs say. Should be easy enough to pass a --docdir or whatever flag in the eclass.
Comment 12 Donnie Berkholz (RETIRED) gentoo-dev 2007-05-08 05:55:26 UTC
*** Bug 169934 has been marked as a duplicate of this bug. ***
Comment 13 Joshua Baergen (RETIRED) gentoo-dev 2007-05-13 17:24:27 UTC
(In reply to comment #11)
> Thought about this more. I agree that these should all get stuck in $PF, since
> that's what the Gentoo docs say. Should be easy enough to pass a --docdir or
> whatever flag in the eclass.
> 

damageproto uses the following to install its docs:
  damagedocdir = $(datadir)/doc/$(PACKAGE)

So I don't think it would be that simple.
Comment 14 Donnie Berkholz (RETIRED) gentoo-dev 2007-05-15 18:11:42 UTC
(In reply to comment #13)
> (In reply to comment #11)
> > Thought about this more. I agree that these should all get stuck in $PF, since
> > that's what the Gentoo docs say. Should be easy enough to pass a --docdir or
> > whatever flag in the eclass.
> > 
> 
> damageproto uses the following to install its docs:
>   damagedocdir = $(datadir)/doc/$(PACKAGE)

I guess we'll have to look for instances of that and try to fix them.
> 

Comment 15 Chris Mayo 2007-09-10 18:45:19 UTC
Adding:
   ${PN/proto/}docdir=/usr/share/doc/${PF}
to make install works for me
Comment 16 Chris Mayo 2007-09-10 18:48:46 UTC
Created attachment 130531 [details, diff]
x-modular.eclass patch

Suggested patch for x-modular.eclass.

The patch works OK for me with randrproto-1.2.1 and compositeproto-0.4 too.
Comment 17 Rémi Cardona (RETIRED) gentoo-dev 2008-10-30 16:08:04 UTC
*** Bug 241558 has been marked as a duplicate of this bug. ***
Comment 18 Rémi Cardona (RETIRED) gentoo-dev 2009-02-27 19:37:35 UTC
*** Bug 234488 has been marked as a duplicate of this bug. ***
Comment 19 Rémi Cardona (RETIRED) gentoo-dev 2009-03-03 16:31:33 UTC
revision 1.106
date: 2009-03-03 17:26:20 +0100;  author: remi;  state: Exp;  lines: +13 -5;  commitid: 7a5b49ad5a2b4567;
install proto docs in /usr/share/doc/${PF} (fixes bug #164917)

Fixed in portage, thanks a bunch for the patch :)
Comment 20 Daniel Pielmeier gentoo-dev 2009-12-06 01:22:30 UTC
What about libxcb? It was also mentioned in this bug along with dia which has been fixed meanwhile.

Adding "--docdir=/usr/share/doc/${PF}" should do here.
Comment 21 Daniel Pielmeier gentoo-dev 2009-12-07 17:57:59 UTC
(In reply to comment #20)
> What about libxcb? It was also mentioned in this bug along with dia which has
> been fixed meanwhile.
> 
> Adding "--docdir=/usr/share/doc/${PF}" should do here.
> 

This is now bug #296096.