public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Göktürk Yüksek" <gokturk@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/
Date: Tue, 29 Dec 2020 22:08:01 +0000 (UTC)	[thread overview]
Message-ID: <1609279597.3c11fdb5423e2258388d0624bf7d6c45b8addf69.gokturk@gentoo> (raw)

commit:     3c11fdb5423e2258388d0624bf7d6c45b8addf69
Author:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Tue Dec 29 02:40:34 2020 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Dec 29 22:06:37 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3c11fdb5

ebuild-writing/functions: prefer "phase functions" over "ebuild functions"

When the text specifically refers to phase functions, be more verbose
about it. Ebuilds can define other functions that are
internal. Eclasses also define functions. Using the term "phase
functions" should help clarify the ambiguity.

Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>

 ebuild-writing/functions/text.xml | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/ebuild-writing/functions/text.xml b/ebuild-writing/functions/text.xml
index a3e11d1..b15c0b1 100644
--- a/ebuild-writing/functions/text.xml
+++ b/ebuild-writing/functions/text.xml
@@ -1,22 +1,22 @@
 <?xml version="1.0"?>
 <guide self="ebuild-writing/functions/">
 <chapter>
-<title>Ebuild Functions</title>
+<title>Ebuild Phase Functions</title>
 
 <body>
 <p>
-When installing packages from source, the function call order is
+When installing packages from source, the phase function call order is
 <c>pkg_pretend</c>, <c>pkg_setup</c>,
 <c>src_unpack</c>, <c>src_prepare</c>, <c>src_configure</c>, <c>src_compile</c>,
 <c>src_test</c> (optional, <c>FEATURES="test"</c>),
 <c>src_install</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>. When installing packages
-from a binary, the function call order is <c>pkg_pretend</c>,
+from a binary, the phase function call order is <c>pkg_pretend</c>,
 <c>pkg_setup</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>.
 As some phases haven't been introduced from the beginning, you can have a look at
 <uri link="::ebuild-writing/eapi"/> for an overview, what have been introduced in which EAPI.
 </p>
 
-<figure short="How the ebuild functions are processed" link="diagram.png"/>
+<figure short="How the ebuild phase functions are processed" link="diagram.png"/>
 
 <p>
 The <c>pkg_pretend</c> function is to be used for performing various
@@ -43,8 +43,9 @@ location, and Portage records digests of the files installed.
 </p>
 
 <p>
-When testing or debugging, you can instruct Portage to execute a specific function
-from an ebuild by using the <c>ebuild</c> command, see the <c>ebuild(1)</c> manual
+When testing or debugging, you can instruct Portage to execute a
+specific phase function of an ebuild by using the <c>ebuild</c>
+command, see the <c>ebuild(1)</c> manual
 page for further information.
 </p>
 


             reply	other threads:[~2020-12-29 22:08 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-29 22:08 Göktürk Yüksek [this message]
  -- strict thread matches above, loose matches on Subject: below --
2021-06-18  5:10 [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/ Sam James
2019-11-12 17:18 Göktürk Yüksek
2019-11-12 17:18 Göktürk Yüksek
2016-06-05 12:43 Göktürk Yüksek
2016-02-23  7:17 Ulrich Müller
2015-09-12 10:58 Markos Chandras
2014-10-18 17:35 Markos Chandras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1609279597.3c11fdb5423e2258388d0624bf7d6c45b8addf69.gokturk@gentoo \
    --to=gokturk@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox