From: Zac Medico <zmedico@gentoo.org>
Date: Mon, 16 Aug 2010 07:10:56 +0000 (-0700)
Subject: Bug #273622 - Add docs for pkg_pretend from PMS 10.1.2.
X-Git-Tag: v2.2_rc68~181
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=13a1d0e6247bd227afd0c9738093e663a989ac30;p=portage.git

Bug #273622 - Add docs for pkg_pretend from PMS 10.1.2.
---

diff --git a/doc/package/ebuild/eapi/4.docbook b/doc/package/ebuild/eapi/4.docbook
index 8d7942b47..9181aa881 100644
--- a/doc/package/ebuild/eapi/4.docbook
+++ b/doc/package/ebuild/eapi/4.docbook
@@ -109,4 +109,26 @@ Finally, please note that this new metadata key can be set by eclasses, and the
 </section>
 </section>
 </section>
+	<section id='package-ebuild-eapi-4_pre1-phases'>
+		<title>Phases</title>
+		<section id='package-ebuild-eapi-4_pre1-phases-pkg-pretend'>
+			<title>New pkg_pretend Phase Function</title>
+			<para>
+			The pkg_pretend function may be used to carry out sanity checks early on in the
+			install process. For example, if an ebuild requires a particular kernel
+			configuration, it may perform that check in pkg_pretend and call eerror and
+			then die with appropriate messages if the requirement is not met.
+			</para>
+			<para>
+			pkg_pretend is run separately from the main phase function sequence, and does
+			not participate in any kind of environment saving. There is no guarantee that
+			any of an ebuild's dependencies will be met at this stage, and no guarantee
+			that the system state will not have changed substantially before the next phase
+			is executed.
+			</para>
+			<para>
+			pkg_pretend must not write to the filesystem.
+			</para>
+		</section>
+	</section>
 </section>