From: | Xavier Neys <neysx@g.o> | ||
---|---|---|---|
To: | gentoo-doc@l.g.o | ||
Subject: | Re: [gentoo-doc] Link to docs in ebuilds | ||
Date: | Thu, 13 Apr 2006 13:36:45 | ||
Message-Id: | 443E53E2.7030907@gentoo.org | ||
In Reply to: | [gentoo-doc] Link to docs in ebuilds by Arun Raghavan |
1 | Arun Raghavan wrote: |
2 | > Hello All, |
3 | > I was just wondering if this has been thought of before -- a lot of |
4 | > ebuilds have a guide that should be read before/after installation. |
5 | > For example, anybody emerge'ing bluez will probably want to read the |
6 | > Gentoo Bluetooth Guide. Does it make sense to do something like this, |
7 | > then: |
8 | > |
9 | > 1) add a RELATED_DOC variable to ebuilds to point to the related documentation |
10 | |
11 | Has already been asked |
12 | http://thread.gmane.org/gmane.linux.gentoo.documentation/2395/focus=2397 |
13 | |
14 | The short answer is it's a good idea, but not one GDP can do anything about. |
15 | The long answer has been discussed on the -dev ML |
16 | http://thread.gmane.org/gmane.linux.gentoo.devel/33433 |
17 | |
18 | > 2) Before/after the first install the user is given an einfo message |
19 | > about the doc |
20 | |
21 | Ebuild writers write ebuilds and many already point to available docs |
22 | |
23 | > 3) I don't know how easy this is, but we can possibly set up some way |
24 | > in which the user can be notified if the doc changes as well. This |
25 | > could either be done by looking up the doc online each time, or |
26 | > putting some more metadata into the ebuild. |
27 | |
28 | Very unrealistic. |
29 | A yet-to-be-released version of viewcvs (now ViewVC) will provide rss feeds |
30 | http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/ |
31 | (See http://viewvc.tigris.org/source/browse/viewvc/trunk/CHANGES?rev=HEAD) |
32 | |
33 | |
34 | Wkr |
35 | -- |
36 | / Xavier Neys |
37 | \_ Gentoo Documentation Project |
38 | / |
39 | /\ http://www.gentoo.org/doc/en/ |
File name | MIME type |
---|---|
signature.asc | application/pgp-signature |