Gentoo Archives: gentoo-doc

From: Josh Saddler <nightmorph@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] Link to docs in ebuilds
Date: Wed, 12 Apr 2006 19:32:34
Message-Id: 443D558B.7080408@gentoo.org
In Reply to: [gentoo-doc] Link to docs in ebuilds by Arun Raghavan
1 -----BEGIN PGP SIGNED MESSAGE-----
2 Hash: SHA1
3
4 Most ebuilds that have docs on gentoo.org already have einfo notices pointing
5 users to read the appropriate docs at their various locations.
6
7 Really, though, if you're wanting a new Portage feature (RELATED_DOC or some
8 other ebuild variable), your best bet is to ask on the portage or gentoo-dev
9 mailing lists and/or the appropriate IRC channels.
10
11 Realistically, though, it's impossible to automatically notify users when a doc
12 changes.
13
14 Arun Raghavan wrote:
15 > Hello All,
16 > I was just wondering if this has been thought of before -- a lot of
17 > ebuilds have a guide that should be read before/after installation.
18 > For example, anybody emerge'ing bluez will probably want to read the
19 > Gentoo Bluetooth Guide. Does it make sense to do something like this,
20 > then:
21 >
22 > 1) add a RELATED_DOC variable to ebuilds to point to the related documentation
23 > 2) Before/after the first install the user is given an einfo message
24 > about the doc
25 > 3) I don't know how easy this is, but we can possibly set up some way
26 > in which the user can be notified if the doc changes as well. This
27 > could either be done by looking up the doc online each time, or
28 > putting some more metadata into the ebuild.
29 >
30 > Thoughts?
31 > --
32 > Arun Raghavan
33 > (http://nemesis.accosted.net)
34 > v2sw5Chw4+5ln4pr6$OFck2ma4+9u8w3+1!m?l7+9GSCKi056
35 > e6+9i4b8/9HTAen4+5g4/8APa2Xs8r1/2p5-8 hackerkey.com
36 >
37 -----BEGIN PGP SIGNATURE-----
38 Version: GnuPG v1.4.2.2 (GNU/Linux)
39
40 iD8DBQFEPVWLrsJQqN81j74RApa7AJ9SuzFVzz+N6k9fyPdTP1F0itIR0gCeIvCJ
41 YulB/9oPmkBLrm0xJcet/nk=
42 =s8aG
43 -----END PGP SIGNATURE-----
44 --
45 gentoo-doc@g.o mailing list