Re: [gentoo-doc] Link to docs in ebuilds

[Xavier Neys]

Arun Raghavan wrote:
> Hello All,
> I was just wondering if this has been thought of before -- a lot of
> ebuilds have a guide that should be read before/after installation.
> For example, anybody emerge'ing bluez will probably want to read the
> Gentoo Bluetooth Guide. Does it make sense to do something like this,
> then:
>
> 1) add a RELATED_DOC variable to ebuilds to point to the related documentation

Has already been asked
http://thread.gmane.org/gmane.linux.gentoo.documentation/2395/focus=2397

The short answer is it's a good idea, but not one GDP can do anything about.
The long answer has been discussed on the -dev ML
http://thread.gmane.org/gmane.linux.gentoo.devel/33433

> 2) Before/after the first install the user is given an einfo message
> about the doc

Ebuild writers write ebuilds and many already point to available docs

> 3) I don't know how easy this is, but we can possibly set up some way
> in which the user can be notified if the doc changes as well. This
> could either be done by looking up the doc online each time, or
> putting some more metadata into the ebuild.

Very unrealistic.
A yet-to-be-released version of viewcvs (now ViewVC) will provide rss feeds
http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/
(See http://viewvc.tigris.org/source/browse/viewvc/trunk/CHANGES?rev=HEAD)


Wkr
-- 
/  Xavier Neys
\_ Gentoo Documentation Project
/
/\ http://www.gentoo.org/doc/en/