Reformat documentation of EAPI="4-python".
[portage.git] / doc / package / ebuild / eapi / 4-python.docbook
index 04457f20341a28809f38a0df61f24bd243b70808..8420abb295f98c63fa3b710cfe5195a1b5c4cd40 100644 (file)
 <section id='package-ebuild-eapi-4-python'>
-<title>EAPI 4-python</title>
-<para>Also see the
-<ulink url="http://people.apache.org/~Arfrever/EAPI_4-python_Specification">
-official EAPI 4-python Specification</ulink>.
-</para>
-<section id='package-ebuild-eapi-4-python-helpers'>
-<title>Helpers</title>
-<section id='package-ebuild-eapi-4-python-helpers-banned-global-scope'>
-<title>Helpers Banned in Global Scope</title>
-<para>
-<itemizedlist>
-<listitem><para>diropts</para></listitem>
-<listitem><para>docompress</para></listitem>
-<listitem><para>exeopts</para></listitem>
-<listitem><para>insopts</para></listitem>
-<listitem><para>keepdir</para></listitem>
-<listitem><para>libopts</para></listitem>
-<listitem><para>use</para></listitem>
-<listitem><para>use_enable</para></listitem>
-<listitem><para>use_with</para></listitem>
-<listitem><para>useq</para></listitem>
-<listitem><para>usev</para></listitem>
-</itemizedlist>
-</para>
-</section>
-</section>
-<section id='package-ebuild-eapi-4-python-package-names-allow-period-characters'>
-<title>Support for Period Characters in Package Names</title>
-<para>
-The "." character is allowed in package names.
-</para>
-</section>
-<section id='package-ebuild-eapi-4-python-use-flag-allow-period-characters'>
-<title>Support for Period Characters in USE Flags</title>
-<para>
-The "." character is allowed in USE flags.
-</para>
-</section>
-<section id='package-ebuild-eapi-4-python-globstar'>
-<title>globstar shell option enabled by default</title>
-<para>
-globstar shell option is enabled by default, which enables recursive expansion of ** pattern in pathname expansion context.
-</para>
-</section>
-<section id='package-ebuild-eapi-4-python-repository-variable'>
-<title>REPOSITORY Variable</title>
-<para>
-The new REPOSITORY variable is set in ebuild environment. This variable contains name of repository, which contains currently used ebuild.
-</para>
-</section>
-<section id='package-ebuild-eapi-4-python-repository-dependencies'>
-<title>Repository Dependencies</title>
-<para>
-Repository dependencies are supported in atoms in DEPEND, PDEPEND and RDEPEND and atoms passed to best_version and has_version functions.
-Repository dependency is specified by two colons followed by repository name.
-</para>
-<table><title>Repository Dependency Examples</title>
-<tgroup cols='1' align='left' >
-<colspec colname='atom'/>
-<thead>
-<row>
-<entry>Atom</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry>dev-lang/python::progress</entry>
-</row>
-<row>
-<entry>&gt;=dev-lang/python-3.2::progress</entry>
-</row>
-<row>
-<entry>dev-lang/python:3.2::progress</entry>
-</row>
-<row>
-<entry>dev-lang/python::progress[xml]</entry>
-</row>
-<row>
-<entry>dev-lang/python:3.2::progress[xml]</entry>
-</row>
-</tbody>
-</tgroup>
-</table>
-</section>
-<section id='package-ebuild-eapi-4-python-repo-level-config'>
-<title>Extended Repository-Level Configuration</title>
-<para>
-Repository-level configuration in ${repository}/profiles is supported for
-the following files:
-<itemizedlist>
-<listitem><para>make.defaults</para></listitem>
-<listitem><para>package.use</para></listitem>
-<listitem><para>package.use.force</para></listitem>
-<listitem><para>package.use.mask</para></listitem>
-<listitem><para>use.force</para></listitem>
-<listitem><para>use.mask</para></listitem>
-</itemizedlist>
-</para>
-<para>
-By default, the following files in ${repository}/profiles can be also directories:
-<itemizedlist>
-<listitem><para>package.mask</para></listitem>
-<listitem><para>package.use</para></listitem>
-<listitem><para>package.use.force</para></listitem>
-<listitem><para>package.use.mask</para></listitem>
-<listitem><para>use.force</para></listitem>
-<listitem><para>use.mask</para></listitem>
-</itemizedlist>
-</para>
-</section>
+       <title>EAPI 4-python</title>
+       <para>
+               Also see the <ulink url="http://people.apache.org/~Arfrever/EAPI_4-python_Specification">official EAPI 4-python Specification</ulink>.
+       </para>
+       <section id='package-ebuild-eapi-4-python-helpers'>
+               <title>Helpers</title>
+               <section id='package-ebuild-eapi-4-python-helpers-banned-in-global-scope'>
+                       <title>Helpers Banned in Global Scope</title>
+                       <para>
+                               <itemizedlist>
+                                       <listitem><para>diropts</para></listitem>
+                                       <listitem><para>docompress</para></listitem>
+                                       <listitem><para>exeopts</para></listitem>
+                                       <listitem><para>insopts</para></listitem>
+                                       <listitem><para>keepdir</para></listitem>
+                                       <listitem><para>libopts</para></listitem>
+                                       <listitem><para>use</para></listitem>
+                                       <listitem><para>use_enable</para></listitem>
+                                       <listitem><para>use_with</para></listitem>
+                                       <listitem><para>useq</para></listitem>
+                                       <listitem><para>usev</para></listitem>
+                               </itemizedlist>
+                       </para>
+               </section>
+       </section>
+       <section id='package-ebuild-eapi-4-python-metadata'>
+               <title>Metadata</title>
+               <section id='package-ebuild-eapi-4-python-metadata-package-names-allow-period-characters'>
+                       <title>Support for Period Characters in Package Names</title>
+                       <para>
+                               The "." character is allowed in package names.
+                       </para>
+               </section>
+               <section id='package-ebuild-eapi-4-python-metadata-use-flags-allow-period-characters'>
+                       <title>Support for Period Characters in USE Flags</title>
+                       <para>
+                               The "." character is allowed in USE flags.
+                       </para>
+               </section>
+               <section id='package-ebuild-eapi-4-python-metadata-repository-dependencies'>
+                       <title>Repository Dependencies</title>
+                       <para>
+                               Repository dependencies are supported in atoms in DEPEND, PDEPEND and RDEPEND and atoms passed to best_version and has_version functions.
+                               Repository dependency is specified by two colons followed by repository name.
+                       </para>
+                       <table><title>Repository Dependency Examples</title>
+                               <tgroup cols='1' align='left'>
+                                       <colspec colname='atom'/>
+                                       <thead>
+                                               <row>
+                                                       <entry>Atom</entry>
+                                               </row>
+                                       </thead>
+                                       <tbody>
+                                               <row>
+                                                       <entry>dev-lang/python::progress</entry>
+                                               </row>
+                                               <row>
+                                                       <entry>&gt;=dev-lang/python-3.2::progress</entry>
+                                               </row>
+                                               <row>
+                                                       <entry>dev-lang/python:3.2::progress</entry>
+                                               </row>
+                                               <row>
+                                                       <entry>dev-lang/python::progress[xml]</entry>
+                                               </row>
+                                               <row>
+                                                       <entry>dev-lang/python:3.2::progress[xml]</entry>
+                                               </row>
+                                       </tbody>
+                               </tgroup>
+                       </table>
+               </section>
+       </section>
+       <section id='package-ebuild-eapi-4-python-globstar'>
+               <title>globstar shell option enabled by default</title>
+               <para>
+                       globstar shell option is enabled by default, which enables recursive expansion of ** pattern in pathname expansion context.
+               </para>
+       </section>
+       <section id='package-ebuild-eapi-4-python-variables'>
+               <title>Variables</title>
+               <section id='package-ebuild-eapi-4-python-variables-repository'>
+                       <title>REPOSITORY Variable</title>
+                       <para>
+                               The new REPOSITORY variable is set in ebuild environment. This variable contains name of repository, which contains currently used ebuild.
+                       </para>
+               </section>
+       </section>
+       <section id='package-ebuild-eapi-4-python-repo-level-config'>
+               <title>Extended Repository-Level Configuration</title>
+               <para>
+                       Repository-level configuration in ${repository}/profiles is supported for the following files:
+                       <itemizedlist>
+                               <listitem><para>make.defaults</para></listitem>
+                               <listitem><para>package.use</para></listitem>
+                               <listitem><para>package.use.force</para></listitem>
+                               <listitem><para>package.use.mask</para></listitem>
+                               <listitem><para>use.force</para></listitem>
+                               <listitem><para>use.mask</para></listitem>
+                       </itemizedlist>
+               </para>
+               <para>
+                       By default, the following files in ${repository}/profiles can be also directories:
+                       <itemizedlist>
+                               <listitem><para>package.mask</para></listitem>
+                               <listitem><para>package.use</para></listitem>
+                               <listitem><para>package.use.force</para></listitem>
+                               <listitem><para>package.use.mask</para></listitem>
+                               <listitem><para>use.force</para></listitem>
+                               <listitem><para>use.mask</para></listitem>
+                       </itemizedlist>
+               </para>
+       </section>
 </section>