Create a single EAPI section to contain all of the EAPI subsections and v2.2_rc8
authorZac Medico <zmedico@gentoo.org>
Tue, 12 Aug 2008 19:54:51 +0000 (19:54 -0000)
committerZac Medico <zmedico@gentoo.org>
Tue, 12 Aug 2008 19:54:51 +0000 (19:54 -0000)
replace sect[1-3] elements with "section" elements which have unbounded
depth.

svn path=/main/trunk/; revision=11402

doc/package/ebuild.docbook
doc/package/ebuild/eapi/0.docbook
doc/package/ebuild/eapi/1.docbook
doc/package/ebuild/eapi/2.docbook
doc/package/ebuild/helper_functions.docbook
doc/package/ebuild/phases.docbook

index 162b79c53d75ef998724980295d68461cbd5a920..ecd88017ab1907c9971c0c3a24496a4617c50236 100644 (file)
@@ -2,7 +2,10 @@
 <title>Ebuild</title>
 &package_ebuild_phases;
 &package_ebuild_helper_functions;
+<section id='package-ebuild-eapi'>
+<title>EAPI</title>
 &package_ebuild_eapi_0;
 &package_ebuild_eapi_1;
 &package_ebuild_eapi_2;
+</section>
 </chapter>
index 72e998b9c48e2d111bf9d4c3c9db239676bc89bf..d00861ccf1ff92788473149113f81c579cc2e750 100644 (file)
@@ -1,8 +1,8 @@
-<sect1 id='package-ebuild-eapi-0'>
+<section id='package-ebuild-eapi-0'>
        <title>EAPI 0</title>
-       <sect2 id='package-ebuild-eapi-0-phases'>
+       <section id='package-ebuild-eapi-0-phases'>
                <title>Phases</title>
-               <sect3 id='package-ebuild-eapi-0-phases-default-src-compile'>
+               <section id='package-ebuild-eapi-0-phases-default-src-compile'>
                        <title>Default src_compile Phase Function</title>
                        <programlisting>
 src_compile() {
@@ -14,6 +14,6 @@ src_compile() {
        fi
 }
                        </programlisting>
-               </sect3>
-       </sect2>
-</sect1>
+               </section>
+       </section>
+</section>
index ad84ae6f9321f333a75515922370dacb064933b1..ca421352f18088b5022ebcef3296d62949eecd77 100644 (file)
@@ -1,8 +1,8 @@
-<sect1 id='package-ebuild-eapi-1'>
+<section id='package-ebuild-eapi-1'>
        <title>EAPI 1</title>
-       <sect2 id='package-ebuild-eapi-1-phases'>
+       <section id='package-ebuild-eapi-1-phases'>
                <title>Phases</title>
-               <sect3 id='package-ebuild-eapi-1-phases-default-src-compile'>
+               <section id='package-ebuild-eapi-1-phases-default-src-compile'>
                        <title>Default src_compile Phase Function</title>
                        <para>
                        Support for the ECONF_SOURCE variable, which is also supported
@@ -18,9 +18,9 @@ src_compile() {
        fi
 }
                        </programlisting>
-               </sect3>
-       </sect2>
-       <sect2 id='package-ebuild-eapi-1-slot-deps'>
+               </section>
+       </section>
+       <section id='package-ebuild-eapi-1-slot-deps'>
        <title>SLOT Dependencies</title>
        <para>
        Any valid atom can be constrained to match a specific SLOT. This is
@@ -50,5 +50,5 @@ src_compile() {
        </tbody>
        </tgroup>
        </table>
-       </sect2>
-</sect1>
+       </section>
+</section>
index 8e152f21d79de260833b9677af3312603b92b752..1a4073e5eb1c2166bf6b08591e47347291b71eba 100644 (file)
@@ -1,8 +1,8 @@
-<sect1 id='package-ebuild-eapi-2_pre1'>
+<section id='package-ebuild-eapi-2_pre1'>
        <title>EAPI 2_pre1</title>
-       <sect2 id='package-ebuild-eapi-2-helpers'>
+       <section id='package-ebuild-eapi-2-helpers'>
        <title>Helpers</title>
-       <sect3 id='package-ebuild-eapi-2-helpers-doman'>
+       <section id='package-ebuild-eapi-2-helpers-doman'>
        <title>doman</title>
        <para>
        Language codes in file names are now used for path translation.
        </tbody>
        </tgroup>
        </table>
-       </sect3>
-       </sect2>
-       <sect2 id='package-ebuild-eapi-2-use-deps'>
+       </section>
+       </section>
+       <section id='package-ebuild-eapi-2-use-deps'>
        <title>USE Dependencies</title>
-       <sect3 id='package-ebuild-eapi-2-use-deps-unconditional'>
+       <section id='package-ebuild-eapi-2-use-deps-unconditional'>
        <title>Unconditional USE Dependencies</title>
        <table><title>Syntax Examples</title>
        <tgroup cols='2' align='left' >
@@ -61,8 +61,8 @@
        </tbody>
        </tgroup>
        </table>
-       </sect3>
-       <sect3 id='package-ebuild-eapi-2-use-deps-conditional'>
+       </section>
+       <section id='package-ebuild-eapi-2-use-deps-conditional'>
        <title>Conditional USE Dependencies</title>
        <table><title>Syntax Examples</title>
        <tgroup cols='2' align='left' >
        </tbody>
        </tgroup>
        </table>
-       </sect3>
-       </sect2>
-</sect1>
-<sect1 id='package-ebuild-eapi-2_pre2'>
+       </section>
+       </section>
+</section>
+<section id='package-ebuild-eapi-2_pre2'>
        <title>EAPI 2_pre2</title>
-       <sect2 id='package-ebuild-eapi-2-phases'>
+       <section id='package-ebuild-eapi-2-phases'>
                <title>Phases</title>
-               <sect3 id='package-ebuild-eapi-2-phases-src-configure'>
+               <section id='package-ebuild-eapi-2-phases-src-configure'>
                        <title>New src_configure Phase Function</title>
                        <para>
                        The configure portion of the src_compile function has been
@@ -164,8 +164,8 @@ src_compile() {
                                </tbody>
                                </tgroup>
                        </table>
-               </sect3>
-               <sect3 id='package-ebuild-eapi-2-phases-default-functions'>
+               </section>
+               <section id='package-ebuild-eapi-2-phases-default-functions'>
                        <title>Default Phase Functions</title>
                        <para>
                        The default pkg_nofetch and src_* phase functions are now
@@ -261,8 +261,8 @@ src_compile() {
                                </tbody>
                                </tgroup>
                        </table>
-               </sect3>
-               <sect3 id='package-ebuild-eapi-2-phases-default-function-alias'>
+               </section>
+               <section id='package-ebuild-eapi-2-phases-default-function-alias'>
                        <title>Default Phase Function Alias</title>
                        <para>
                        A function named "default" is redefined for each phase so that it
@@ -271,6 +271,6 @@ src_compile() {
                        src_compile phase is equivalent to a call to the function named
                        default_src_compile.
                        </para>
-               </sect3>
-       </sect2>
-</sect1>
+               </section>
+       </section>
+</section>
index 9c417afb90e1162f1383d39e1f28c00e40439dc4..1a4737c5ba265615d5c019bba9e2a942188c9753 100644 (file)
@@ -1,31 +1,31 @@
-<sect1 id='package-ebuild-helper-functions'>
+<section id='package-ebuild-helper-functions'>
        <title>Helper Functions</title>
-       <sect2 id='package-ebuild-helper-functions-output'>
+       <section id='package-ebuild-helper-functions-output'>
        <title>Output</title>
-       <sect3 id='package-ebuild-helper-functions-output-ebegin'>
+       <section id='package-ebuild-helper-functions-output-ebegin'>
        <title>ebegin</title>
        <para>
        Like einfo, we output a helpful message and then hint that the following
        operation may take some time to complete. Once the task is finished, you
        need to call eend.
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-helper-functions-output-eend'>
+       </section>
+       <section id='package-ebuild-helper-functions-output-eend'>
        <title>eend</title>
        <para>
        Followup the ebegin message with an appropriate "OK" or "!!" (for errors)
        marker. If status is non-zero, then the additional error message is
        displayed.
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-helper-functions-output-einfo'>
+       </section>
+       <section id='package-ebuild-helper-functions-output-einfo'>
        <title>einfo</title>
        <para>
        Same as elog, but should be used when the message isn't important
        to the user (like progress or status messages during the build process).
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-helper-functions-output-elog'>
+       </section>
+       <section id='package-ebuild-helper-functions-output-elog'>
        <title>elog</title>
        <para>
        If you need to display a message that you wish the user to read
        but adds a little more to the output so as to catch the user's eye.
        The message will also be logged by portage for later review.
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-helper-functions-output-eqawarn'>
+       </section>
+       <section id='package-ebuild-helper-functions-output-eqawarn'>
        <title>eqawarn</title>
        <para>
        Same as einfo, but should be used when showing a QA warning to the user.
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-helper-functions-output-ewarn'>
+       </section>
+       <section id='package-ebuild-helper-functions-output-ewarn'>
        <title>ewarn</title>
        <para>
        Same as einfo, but should be used when showing a warning to the user.
        </para>
-       </sect3>
-       </sect2>
-</sect1>
+       </section>
+       </section>
+</section>
index 383c605cea2575c9afdf94c8f32c1da3caba0210..2cb1b4447bdda82b2c3113bd969111f6038946e3 100644 (file)
@@ -1,4 +1,4 @@
-<sect1 id='package-ebuild-phases'>
+<section id='package-ebuild-phases'>
        <title>Ebuild Phases</title>
        <para>
        Ebuild execution is divided into a series of phases. In order
        </listitem>
        </itemizedlist>
        </para>
-       <sect2 id='package-ebuild-phases-previous-installed'>
+       <section id='package-ebuild-phases-previous-installed'>
        <title>Interaction with previous installed version</title>
        <para>
        The order for upgrade and downgrade operations changed in
        version 2.1.5, but the order for reinstall operations remained unchanged.
        </para>
-       <sect3 id='package-ebuild-phases-before-2.1.5'>
+       <section id='package-ebuild-phases-before-2.1.5'>
        <title>Upgrade/downgrade order used by versions less than 2.1.5 (deprecated)</title>
        <para>
        <itemizedlist>
@@ -64,8 +64,8 @@
        </listitem>
        </itemizedlist>
        </para>
-       </sect3>
-       <sect3 id='package-ebuild-phases-after-2.1.5'>
+       </section>
+       <section id='package-ebuild-phases-after-2.1.5'>
        <title>Upgrade/downgrade order starting with version 2.1.5</title>
        <para>
        The new order for upgrades and downgrades is identical to the order used
@@ -95,6 +95,6 @@
        pkg_preinst) and store the result in a global variable to be accessed by
        pkg_postinst when it is called.
        </para>
-       </sect3>
-       </sect2>
-</sect1>
+       </section>
+       </section>
+</section>