Bug 232895

Summary:	Detailed Eclass Reference needed!
Product:	[OLD] Docs on www.gentoo.org	Reporter:	r01 <crquan>
Component:	New Documentation	Assignee:	Docs Team <docs-team>
Status:	RESOLVED WONTFIX
Severity:	normal
Priority:	High
Version:	unspecified
Hardware:	All
OS:	Linux
URL:	http://www.gentoo.org/doc/en/index.xml?catid=gentoodev
Whiteboard:
Package list:		Runtime testing required:	---

Description r01 2008-07-25 05:02:46 UTC

I'm writing an ebuild for some package, and I think some installation task in this ebuild is common for many packages, I want to check whether this common function has been provided by some eclass or not, but there are no online eclass reference at all, the ideal place for it will be the "Gentoo Development Documentation":

http://www.gentoo.org/doc/en/index.xml?catid=gentoodev

In addition, I have searched on the web and found there are some several eclass reference here, but not full list:

http://devmanual.gentoo.org/eclass-reference/index.html

I have installed app-portage/eclass-manpages, but these manpages didn't help much, there's need for online documentation. thanks.

Comment 1 nm (RETIRED) gentoo-dev

2008-07-25 06:26:56 UTC

We don't maintain the devmanual. The devmanual is clearly marked as the property of QA -- qa@gentoo.org, so bugs for it should be addressed to them.

Also, the devmanual does have good material on the eclasses, but you should also read the eclasses themselves to see how they work.

Also, check the developer handbook at http://www.gentoo.org/proj/en/devrel/handbook

Support requests like this really shouldn't be filed in Bugzilla. A better place would be the Gentoo Forums (http://forums.gentoo.org) or the IRC channel: #gentoo-dev-help on irc.freenode.net

Comment 2 Peter Volkov (RETIRED) gentoo-dev

2008-08-21 06:07:23 UTC

Denis, I would like to add eclasses are bash script and are very easy to read. So use source as a reference - that's very easy in this case.

Comment 3 r01 2008-08-21 06:26:19 UTC

I think we can parse every function and its comments from every eclass scripts, generate a basic eclass reference, and put it under gentoo.org/doc/ .

Comment 4 Peter Volkov (RETIRED) gentoo-dev

2008-09-10 07:52:33 UTC

(In reply to comment #3)
> I think we can parse every function and its comments from every eclass scripts,
> generate a basic eclass reference, and put it under gentoo.org/doc/ .

And this is already done with eclass-manpages. Not all eclasses are have such descriptions but some do and some patches to make eclasses manpages ready are pending. If you wish to help here you just need to convert existing comments in eclass to eclass-manpages format and attach diff to bugzilla (like mren does in bug 210058 and similar). Enjoy.

Comment 5 SpanKY gentoo-dev

2008-12-07 09:53:09 UTC

any sort of manual step is doomed to failure.  this is really a dupe of Bug 202656.