Gentoo Archives: gentoo-doc

From: Xavier Neys <neysx@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] linking between portage and relevant documents
Date: Sun, 18 Dec 2005 10:39:53
Message-Id: 43A53C47.8040805@gentoo.org
In Reply to: [gentoo-doc] linking between portage and relevant documents by pclouds
1 pclouds wrote:
2 > Hi,
3 > While translating documents, i found that several documents have not
4 > updated to reflect current packages in portage (sorry i forgot most of
5 > them).
6
7 That's not very helpful then.
8 If you find that a doc that needs to be fixed, it needs to be fixed, as simple
9 as that. Please file a bug, a patch, send a mail, whatever.
10
11 > I would like to suggest making a link between a document and
12 > relevant packages. Then we could encourage devs to check these
13 > documents when they update packages and suggest doc team to fix docs.
14 > It'd also be useful for users if we publish these info on
15 > packages.g.o, show links to documents revelant to packages.
16 > These info could be stored in package's metadata.xml (for example
17 > alsa* package's metadata.xml would have a link to alsa-guide.xml).
18 > Category's metadata.xml could be used too (for example,
19 > sys-kernel/metadata.xml should contain a link to kernel-guide.xml,
20 > this document need to be updated really, gentoo-dev-sources have died
21 > for months and should be removed from the doc).
22 > I'd like to know doc team's comment first before post it to
23 > gentoo-dev. Any comment?
24
25 Adding a <doc> tag to metadata.xml has been discussed recently on -dev.
26 Once the guys in charge of metadata.xml have implemented support for it, and
27 once the devs have added the info to their packages' metadata.xml, and once
28 the guys in charge of p.g.o use it, it will magically work.
29 None of that is in the hands of GDP.
30
31
32 Cheers,
33 --
34 / Xavier Neys
35 \_ Gentoo Documentation Project
36 / French & Internationalisation Lead
37 \ http://www.gentoo.org/doc/en
38 /\
39 --
40 gentoo-doc@g.o mailing list

Replies

Subject Author
Re: [gentoo-doc] linking between portage and relevant documents pclouds <pclouds@×××××.com>