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: ebuild-writing/functions/
Date: Tue, 29 Dec 2020 22:08:05
Message-Id: 1609279597.3c11fdb5423e2258388d0624bf7d6c45b8addf69.gokturk@gentoo
1 commit: 3c11fdb5423e2258388d0624bf7d6c45b8addf69
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:06:37 2020 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3c11fdb5
7
8 ebuild-writing/functions: 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
17 ebuild-writing/functions/text.xml | 13 +++++++------
18 1 file changed, 7 insertions(+), 6 deletions(-)
19
20 diff --git a/ebuild-writing/functions/text.xml b/ebuild-writing/functions/text.xml
21 index a3e11d1..b15c0b1 100644
22 --- a/ebuild-writing/functions/text.xml
23 +++ b/ebuild-writing/functions/text.xml
24 @@ -1,22 +1,22 @@
25 <?xml version="1.0"?>
26 <guide self="ebuild-writing/functions/">
27 <chapter>
28 -<title>Ebuild Functions</title>
29 +<title>Ebuild Phase Functions</title>
30
31 <body>
32 <p>
33 -When installing packages from source, the function call order is
34 +When installing packages from source, the phase function call order is
35 <c>pkg_pretend</c>, <c>pkg_setup</c>,
36 <c>src_unpack</c>, <c>src_prepare</c>, <c>src_configure</c>, <c>src_compile</c>,
37 <c>src_test</c> (optional, <c>FEATURES="test"</c>),
38 <c>src_install</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>. When installing packages
39 -from a binary, the function call order is <c>pkg_pretend</c>,
40 +from a binary, the phase function call order is <c>pkg_pretend</c>,
41 <c>pkg_setup</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>.
42 As some phases haven't been introduced from the beginning, you can have a look at
43 <uri link="::ebuild-writing/eapi"/> for an overview, what have been introduced in which EAPI.
44 </p>
45
46 -<figure short="How the ebuild functions are processed" link="diagram.png"/>
47 +<figure short="How the ebuild phase functions are processed" link="diagram.png"/>
48
49 <p>
50 The <c>pkg_pretend</c> function is to be used for performing various
51 @@ -43,8 +43,9 @@ location, and Portage records digests of the files installed.
52 </p>
53
54 <p>
55 -When testing or debugging, you can instruct Portage to execute a specific function
56 -from an ebuild by using the <c>ebuild</c> command, see the <c>ebuild(1)</c> manual
57 +When testing or debugging, you can instruct Portage to execute a
58 +specific phase function of an ebuild by using the <c>ebuild</c>
59 +command, see the <c>ebuild(1)</c> manual
60 page for further information.
61 </p>