803149 – eclass-writing: "Best practices" section

Bug 803149 - eclass-writing: "Best practices" section

Summary: eclass-writing: "Best practices" section

Status:	UNCONFIRMED

Alias:	None

Product:	Documentation
Classification:	Unclassified
Component:	Devmanual (show other bugs)
Hardware:	All Linux

Importance:	Normal enhancement
Assignee:	Gentoo Devmanual Team

URL:
Whiteboard:
Keywords:	NeedPatch

Depends on:
Blocks:

Reported:	2021-07-21 01:21 UTC by Anna Vyalkova
Modified:	2021-08-07 10:15 UTC (History)
CC List:	1 user (show)

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

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Anna Vyalkova 2021-07-21 01:21:29 UTC

What could be documented:

* Use cases for functional and declarative style

* Common EXPORT_FUNCTION values for build system eclasses, unpacker eclasses etc.

* Most common EAPI compatibility check snippet (one in devmanual is used nowhere)

* "if [[ ! ${_ECLASS} ]]" snippet

* How to debug eclasses

References:
https://blogs.gentoo.org/mgorny/2019/11/06/gentoo-eclass-design-pitfalls/