Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 543628 - devmanual: Improve quickstart examples
Summary: devmanual: Improve quickstart examples
Status: RESOLVED NEEDINFO
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL: https://devmanual.gentoo.org/quickstart/
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-03-17 17:26 UTC by James Horton
Modified: 2015-03-17 21:05 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description James Horton 2015-03-17 17:26:16 UTC
Needs update (EAPI-5) epatch-user and such general issues.
Comment 1 Markos Chandras (RETIRED) gentoo-dev 2015-03-17 18:54:43 UTC
I don't understand the title. Please be more specific and re-open it if needed
Comment 2 James Horton 2015-03-17 19:33:17 UTC
This quickstart guide has not been updated to reflect some important changes.

For example:

EAPI 4 is used in the example but there has been a major push to update
most ebuilds to EAPI 5.

Most ebuilds now make use of eclass. The example probably should have
an example of a simple  eclass usage.

Perhaps the example should have the "inherit" line also.

Perhaps the quickstart guide should list a few ebuilds for references
as simple, current examples, at the end of the guide for readers ready
for more detailed examples.


These are suggestions. If the maintainer thinks the current quickstart guide
is sufficient, or there are plans afoot to update it after EAPI-6 is in beta,
then just close the bug. Since I am relatively new to ebuilds, I look at this document, thinking it is a good idea, and found it a wee bit light on details.

Perhaps it should be "reconstituted" to lead into a wiki page about
epatch-user, as that was my hope. YMMV.

James
Comment 3 Markos Chandras (RETIRED) gentoo-dev 2015-03-17 21:05:42 UTC
There are not so many differences between EAPI4 and EAPI5 so the examples are mostly ok. It might be as simple as doing a s/EAPI4/EAPI5/ and the ebuilds will still be correct. The ebuilds are real so no need to link to external ebuilds as you suggested.

There is an example which "inherits" the eutils eclass so that bit is covered as well.

The epatch_user is part of the eutils eclass. I see no reason why we should mention this particular function in the quickstart guide. This is really detailed information which one should uncover himself as he gets more involved with ebuild development and eclasses

If you have some changes in mind, please re-open this bug and attach git patches here or open pull requests on github.