Gentoo Archives: gentoo-commits

From: "Göktürk Yüksek" <gokturk@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:master commit in: eclass-writing/
Date: Tue, 29 Dec 2020 22:08:05
Message-Id: 1609279650.f7cc34083e1b3447dde176963f98c1bf50b29f0b.gokturk@gentoo
1 commit: f7cc34083e1b3447dde176963f98c1bf50b29f0b
2 Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
3 AuthorDate: Tue Dec 29 02:40:34 2020 +0000
4 Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
5 CommitDate: Tue Dec 29 22:07:30 2020 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f7cc3408
7
8 eclass-writing: prefer "phase functions" over "ebuild functions"
9
10 When the text specifically refers to phase functions, be more verbose
11 about it. Ebuilds can define other functions that are
12 internal. Eclasses also define functions. Using the term "phase
13 functions" should help clarify the ambiguity.
14
15 Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
16 Closes: https://github.com/gentoo/devmanual/pull/183
17
18 eclass-writing/text.xml | 4 ++--
19 1 file changed, 2 insertions(+), 2 deletions(-)
20
21 diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
22 index 6598f9a..d0048b3 100644
23 --- a/eclass-writing/text.xml
24 +++ b/eclass-writing/text.xml
25 @@ -643,7 +643,7 @@ domacosapp() {
26 <body>
27
28 <p>
29 -An eclass may provide default implementations for any of the standard ebuild
30 +An eclass may provide default implementations for any of the ebuild phase
31 functions (<c>src_unpack</c>, <c>pkg_postinst</c> etc). This can be done either as a
32 simple function definition (which is not multiple eclass friendly) or using
33 <c>EXPORT_FUNCTIONS</c>. Functions given to <c>EXPORT_FUNCTIONS</c> are implemented
34 @@ -651,7 +651,7 @@ as normal, but have their name prefixed with <c>${ECLASS}_</c>.
35 </p>
36
37 <important>
38 -Only 'standard' functions should be specified in <c>EXPORT_FUNCTIONS</c>.
39 +Only the ebuild phase functions may be specified in <c>EXPORT_FUNCTIONS</c>.
40 </important>
41
42 <note><c>EXPORT_FUNCTIONS</c> is a function, <e>not</e> a variable.</note>