Add EAPI 5_pre2 with features approved by council
[portage.git] / doc / package / ebuild / eapi / 5.docbook
index 0894eba2a827cac9d076e7e3cdc908a6ef0f3902..c910092c6831a89b643cee58324fb1ca33da592a 100644 (file)
@@ -1,8 +1,8 @@
-<section id='package-ebuild-eapi-5_pre1'>
-<title>EAPI 5_pre1</title>
-<section id='package-ebuild-eapi-5_pre1-metadata'>
+<section id='package-ebuild-eapi-5_pre2'>
+<title>EAPI 5_pre2</title>
+<section id='package-ebuild-eapi-5_pre2-metadata'>
 <title>Metadata</title>
-<section id='package-ebuild-eapi-5_pre1-metadata-required-use-at-most-one-of'>
+<section id='package-ebuild-eapi-5_pre2-metadata-required-use-at-most-one-of'>
 <title>REQUIRED_USE supports new at-most-one-of operator</title>
 <para>
 The new at-most-one-of operator consists of the string '??',
@@ -10,7 +10,7 @@ and is satisfied if zero or one (but no more) of its child
 elements is matched.
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-metadata-slot-sub-slot'>
+<section id='package-ebuild-eapi-5_pre2-metadata-slot-sub-slot'>
 <title>SLOT supports optional "sub-slot" part</title>
 <para>
 The SLOT variable may contain an optional sub-slot part that
@@ -24,11 +24,11 @@ implicit sub-slot which is equal to the regular slot.
 </para>
 <para>
 Refer to the
-<link linkend="package-ebuild-eapi-5_pre1-metadata-dependency-atom-slot-operators">
+<link linkend="package-ebuild-eapi-5_pre2-metadata-dependency-atom-slot-operators">
 slot operators</link> documentation for more information about sub-slot usage.
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-metadata-dependency-atom-slot-operators'>
+<section id='package-ebuild-eapi-5_pre2-metadata-dependency-atom-slot-operators'>
 <title>Dependency atom slot operators</title>
 <para>
 A slot dependency may contain an optional sub-slot part that
@@ -70,9 +70,9 @@ the regular slot).
 </para>
 </section>
 </section>
-<section id='package-ebuild-eapi-5_pre1-profile'>
+<section id='package-ebuild-eapi-5_pre2-profile'>
 <title>Profiles</title>
-<section id='package-ebuild-eapi-5_pre1-profile-iuse-injection'>
+<section id='package-ebuild-eapi-5_pre2-profile-iuse-injection'>
 <title>Profile IUSE Injection</title>
 <para>
 IUSE_EFFECTIVE is a variable calculated from IUSE and
@@ -156,7 +156,7 @@ equivalent of ${v}.
 </table>
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-profile-stable-use-masking'>
+<section id='package-ebuild-eapi-5_pre2-profile-stable-use-masking'>
 <title>Profile stable USE forcing and masking</title>
 <para>
 In profile directories with an EAPI supporting stable masking,
@@ -168,29 +168,29 @@ only influence packages that are merged due to a stable keyword.
 </para>
 </section>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers'>
+<section id='package-ebuild-eapi-5_pre2-helpers'>
 <title>Helpers</title>
-<section id='package-ebuild-eapi-5_pre1-helpers-econf-disable-silent-rules'>
+<section id='package-ebuild-eapi-5_pre2-helpers-econf-disable-silent-rules'>
 <title>econf adds --disable-silent-rules</title>
 <para>
 This option will automatically be passed if
 --disable-silent-rules occurs in the output of configure --help.
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers-newfoo-stdin'>
+<section id='package-ebuild-eapi-5_pre2-helpers-newfoo-stdin'>
 <title>new* commands can read from standard input</title>
 <para>
 Standard input is read when the first parameter is - (a hyphen).
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers-foo-version-host-root'>
+<section id='package-ebuild-eapi-5_pre2-helpers-foo-version-host-root'>
 <title>New option --host-root for {has,best}_version</title>
 <para>
 This option --host-root will cause the query to apply to the
 host root instead of ROOT.
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers-doheader'>
+<section id='package-ebuild-eapi-5_pre2-helpers-doheader'>
 <title>New doheader helper function</title>
 <para>
 Installs the given header files into /usr/include/, by default
@@ -198,7 +198,7 @@ with file mode 0644. This can be overridden by setting
 INSOPTIONS with the insopts function.
 </para>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers-usex'>
+<section id='package-ebuild-eapi-5_pre2-helpers-usex'>
 <title>New usex helper function</title>
 <programlisting>
 USAGE: usex &lt;USE flag&gt; [true output] [false output] [true suffix] [false suffix]
@@ -207,38 +207,10 @@ DESCRIPTION:
  otherwise echo [false output][false suffix] (defaults to "no").
 </programlisting>
 </section>
-<section id='package-ebuild-eapi-5_pre1-helpers-apply-user-patches'>
-<title>New apply_user_patches helper function</title>
-<para>
-This function is called to indicate to the package manager
-that now would be a suitable time to apply any user patches
-to the work directory. This function must return zero if it
-is possible that any changes were made to the work directory,
-and may return non-zero if no changes were made. This function
-must be called at least once in src_prepare; if the function
-is called more than once, it is expected that any effects that
-it has shall only be executed once, and that its return value
-shall only be zero once.
-</para>
 </section>
-</section>
-<section id='package-ebuild-eapi-5_pre1-phases'>
+<section id='package-ebuild-eapi-5_pre2-phases'>
 <title>Phases</title>
-<section id='package-ebuild-eapi-5_pre1-phases-src-prepare-user-patches'>
-<title>src_prepare must call apply_user_patches</title>
-<para>
-If the src_prepare function is implemented then it must call
-the apply_user_patches function at least once. If src_prepare
-does not call apply_user_patches before it returns, then it will
-be treated as a fatal error. The default src_prepare
-implementation will call apply_user_patches automatically.
-Refer to the
-<link linkend="package-ebuild-eapi-5_pre1-helpers-apply-user-patches">
-apply_user_patches section</link> for additional usage
-instructions.
-</para>
-</section>
-<section id='package-ebuild-eapi-5_pre1-phases-src-test-parallel'>
+<section id='package-ebuild-eapi-5_pre2-phases-src-test-parallel'>
 <title>src_test supports parallel tests</title>
 <para>
 Unlike older EAPIs, the default src_test implementation will not
@@ -246,9 +218,9 @@ pass the -j1 option to emake.
 </para>
 </section>
 </section>
-<section id='package-ebuild-eapi-5_pre1-ebuild-environment-variables'>
+<section id='package-ebuild-eapi-5_pre2-ebuild-environment-variables'>
 <title>Ebuild Environment Variables</title>
-<section id='package-ebuild-eapi-5_pre1-ebuild-environment-variables-ebuild-phase-func'>
+<section id='package-ebuild-eapi-5_pre2-ebuild-environment-variables-ebuild-phase-func'>
 <title>New EBUILD_PHASE_FUNC variable</title>
 <para>
 During execution of an ebuild phase function (such as pkg_setup