From: Zac Medico <zmedico@gentoo.org>
Date: Mon, 16 Aug 2010 08:36:39 +0000 (-0700)
Subject: Bug #273648 - Document restriction of S to WORKDIR fallback in EAPI 4.
X-Git-Tag: v2.2_rc68~173
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=886fd42ab4acd3a3ab8014d7846835ed00532a71;p=portage.git

Bug #273648 - Document restriction of S to WORKDIR fallback in EAPI 4.
---

diff --git a/doc/package/ebuild/eapi/4.docbook b/doc/package/ebuild/eapi/4.docbook
index 44e005f45..a96910e83 100644
--- a/doc/package/ebuild/eapi/4.docbook
+++ b/doc/package/ebuild/eapi/4.docbook
@@ -193,6 +193,19 @@ src_install() {
 }
 			</programlisting>
 		</section>
+		<section id='package-ebuild-eapi-4_pre1-phases-s-workdir-fallback'>
+			<title>S to WORKDIR fallback restricted</title>
+			<para>
+			For any of the src_* phases that executes after src_unpack,
+			it is invalid for the S variable to refer to a non-existent
+			directory. However, these src_* phases are exempt from this
+			requirement if none of the prior src_* phases are defined by the
+			ebuild. When a src_* phase is exempt from this requirement, if the
+			S variable does not refer to an existing directory, the
+			WORKDIR directory will be used instead of S as the initial working
+			directory.
+			</para>
+		</section>
 	</section>
 	<section id='package-ebuild-eapi-4_pre1-variables'>
 		<title>Variables</title>