Gentoo Archives: gentoo-dev

From: Ulrich Mueller <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] RFC: deprecate /usr/share/doc/$PF
Date: Mon, 19 Dec 2011 08:24:41
Message-Id: 20206.62623.992831.887143@a1i15.kph.uni-mainz.de
In Reply to: Re: [gentoo-dev] RFC: deprecate /usr/share/doc/$PF by Alexandre Rostovtsev
1 >>>>> On Mon, 19 Dec 2011, Alexandre Rostovtsev wrote:
2
3 > I am forced to agree with your points #1 and #2.
4
5 Good. :-)
6
7 > $CATEGORY/$PN-$SLOT is optimized for the "bookmark a document and go
8 > back to it a week later" use case, but you are correct that it would
9 > work poorly for the "quickly look up a doc that you had not cared
10 > about until now" use case.
11
12 > Using /usr/share/doc/$PN-$SLOT with exceptions for packages that
13 > have the same ($PN, $SLOT) but different categories would not scale:
14 > it turns out there are >100 of them in the main tree.
15
16 Probably most of them in app-emacs and app-xemacs.
17
18 > Using /usr/share/doc/$P would be worse than the current situation:
19 > doc locations would still shift on minor version bumps, and packages
20 > with multiple slots in the same $P (e.g. webkit-gtk) would collide.
21
22 > And using $CATEGORY after $PN is simply too ugly to contemplate.
23
24 I agree.
25
26 > Fortunately, there *is* a neat solution.
27
28 > Symlinks.
29
30 > In other words: no change to dodoc/newdoc/dohtml, they will continue
31 > to install documentation in /usr/share/doc/$PF like they do today.
32
33 > BUT the package manager will automatically create a symlink
34 > from /usr/share/doc/$CATEGORY/$PN (for slot 0) or
35 > from /usr/share/doc/$CATEGORY/$PN-$SLOT (for slot != 0)
36 > to /usr/share/doc/$PF. This would have to be done after the end of
37 > src_install() so that the symlink goes in the VDB.
38
39 Maybe the symlinks should live in a different directory? Otherwise it
40 could be confusing for packages like gnustep-base or net-dns whose
41 name is equal to a category name.
42
43 Also I think that the slot should better be separated by a character
44 that cannot occur in a package name, i.e. something other than
45 hyphen (-), plus sign (+), or underscore (_). What was the problem
46 with the colon (:) again?
47
48 > I think that this change, similarly to the automatic .la file
49 > fixing, could be implemented by portage without waiting for a new
50 > EAPI.
51
52 Not sure about this one. It's not Portage only, but affects all
53 package managers.
54
55 Ulrich

Replies

Subject Author
[gentoo-dev] Re: RFC: deprecate /usr/share/doc/$PF Duncan <1i5t5.duncan@×××.net>