From: Alexandre Rostovtsev <tetromino@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] RFC: deprecate /usr/share/doc/$PF
Date: Sun, 18 Dec 2011 20:52:54 -0500 [thread overview]
Message-ID: <1324259574.12311.86.camel@rook> (raw)
In-Reply-To: <20206.32890.171045.50686@a1i15.kph.uni-mainz.de>
On Mon, 2011-12-19 at 01:08 +0100, Ulrich Mueller wrote:
> [Why are there different Reply-To: headers in -dev and in -pms MLs?
> Following up to both lists.]
I apologize for the mess; I had intended to bring the question up before
a wider audience, but failed to think through the consequences of two
mailing lists ending up in the reply-to.
For the sake of keeping discussion in one thread, I ask that further
replies should be made to gentoo-dev, not gentoo-pms.
> How do you handle FEATURES="nodoc" if you spread the documentation all
> over the filesystem? Should Portage learn about all the special cases?
> IMHO it would make more sense to leave the documentation under
> /usr/share/doc and either configure the documentation viewer to find
> it there, or (if that's not possible) create symlinks.
It's not "all over the filesystem"; in practice, the number of locations
I believe is fairly small (/usr/share/gtk-doc and /usr/lib/monodoc for
API documentation, and /usr/share/help, /usr/share/omf,
and /usr/share/doc/HTML for end-user help files are the only ones that I
know of), and adding them to portage's nodoc list seems much easier than
editing hundreds of ebuilds that already install docs there.
Documentation in Gentoo-specific /usr/share/doc subdirectories would not
be able to link to documentation pages in other packages without
fragile, hard-to-maintain scripts - and even with the best scripts,
things would break on package renames. Symlinks could work, but (if the
nodoc situation is resolved) would give package maintainers extra work
for no real benefit.
> Can we please avoid the bloat of another directory level here?
> ${CATEGORY}/${PN} will be even longer than ${PF} in most cases.
The problem is that ($PN, $CATEGORY) pairs are not unique. Think of
x11-terms/terminal:0 and gnustep-apps/terminal:0, or app-misc/beagle:0
and sci-libs/beagle:0, or app-misc/nut:0 and sys-power/nut:0. I could
not think of any better solution than using $CATEGORY/$PN-$SLOT. Do you
have a better proposal that does not rely on $PVR?
> If we change our policy, then we should move everything to the new
> location (with a transition period of course). It would be very
> inconvenient for users if they had to search two different places
> for documentation.
If everything is to be moved to the new locations, we will need an
eclass-based solution to replace dodoc/dohtml for existing EAPIs.
-Alexandre.
next prev parent reply other threads:[~2011-12-19 1:53 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-18 21:49 [gentoo-dev] RFC: deprecate /usr/share/doc/$PF Alexandre Rostovtsev
2011-12-18 22:02 ` Michał Górny
2011-12-18 23:07 ` Pacho Ramos
2011-12-19 8:31 ` Michał Górny
2011-12-19 10:47 ` Pacho Ramos
2011-12-19 2:26 ` Alexandre Rostovtsev
2011-12-19 2:41 ` Jeroen Roovers
2011-12-19 5:31 ` Alexandre Rostovtsev
2011-12-19 11:48 ` Jeroen Roovers
2011-12-18 22:07 ` Chí-Thanh Christopher Nguyễn
2011-12-19 0:56 ` Alexandre Rostovtsev
2011-12-19 0:08 ` Ulrich Mueller
2011-12-19 1:52 ` Alexandre Rostovtsev [this message]
2011-12-19 4:23 ` Ulrich Mueller
2011-12-19 4:48 ` Dale
2011-12-19 13:29 ` [gentoo-dev] " Duncan
2011-12-19 6:41 ` [gentoo-dev] " Alexandre Rostovtsev
2011-12-19 8:23 ` Ulrich Mueller
2011-12-19 13:51 ` [gentoo-dev] " Duncan
2011-12-19 9:02 ` [gentoo-dev] " Michał Górny
2011-12-19 9:03 ` Ciaran McCreesh
2011-12-19 8:35 ` Michał Górny
2011-12-19 10:08 ` Stelian Ionescu
2011-12-21 1:44 ` Maciej Mrozowski
2011-12-21 3:40 ` Mike Frysinger
2011-12-27 17:29 ` Maciej Mrozowski
2012-01-18 11:12 ` Mike Frysinger
2011-12-27 17:39 ` Andreas K. Huettel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1324259574.12311.86.camel@rook \
--to=tetromino@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox