summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZac Medico <zmedico@gentoo.org>2008-08-12 19:54:51 +0000
committerZac Medico <zmedico@gentoo.org>2008-08-12 19:54:51 +0000
commita5b60005a03208fbde43080ef2919f3cb911faca (patch)
treee72facd5a7bd5aed9ee017bb884068dfcf4073a9 /doc
parentBug #234478 - Fix config._getMissingLicenses() to only access USE when (diff)
downloadportage-multirepo-a5b60005a03208fbde43080ef2919f3cb911faca.tar.gz
portage-multirepo-a5b60005a03208fbde43080ef2919f3cb911faca.tar.bz2
portage-multirepo-a5b60005a03208fbde43080ef2919f3cb911faca.zip
Create a single EAPI section to contain all of the EAPI subsections andv2.2_rc8
replace sect[1-3] elements with "section" elements which have unbounded depth. svn path=/main/trunk/; revision=11402
Diffstat (limited to 'doc')
-rw-r--r--doc/package/ebuild.docbook3
-rw-r--r--doc/package/ebuild/eapi/0.docbook12
-rw-r--r--doc/package/ebuild/eapi/1.docbook16
-rw-r--r--doc/package/ebuild/eapi/2.docbook44
-rw-r--r--doc/package/ebuild/helper_functions.docbook32
-rw-r--r--doc/package/ebuild/phases.docbook16
6 files changed, 63 insertions, 60 deletions
diff --git a/doc/package/ebuild.docbook b/doc/package/ebuild.docbook
index 162b79c5..ecd88017 100644
--- a/doc/package/ebuild.docbook
+++ b/doc/package/ebuild.docbook
@@ -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>
diff --git a/doc/package/ebuild/eapi/0.docbook b/doc/package/ebuild/eapi/0.docbook
index 72e998b9..d00861cc 100644
--- a/doc/package/ebuild/eapi/0.docbook
+++ b/doc/package/ebuild/eapi/0.docbook
@@ -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>
diff --git a/doc/package/ebuild/eapi/1.docbook b/doc/package/ebuild/eapi/1.docbook
index ad84ae6f..ca421352 100644
--- a/doc/package/ebuild/eapi/1.docbook
+++ b/doc/package/ebuild/eapi/1.docbook
@@ -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>
diff --git a/doc/package/ebuild/eapi/2.docbook b/doc/package/ebuild/eapi/2.docbook
index 8e152f21..1a4073e5 100644
--- a/doc/package/ebuild/eapi/2.docbook
+++ b/doc/package/ebuild/eapi/2.docbook
@@ -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.
@@ -29,11 +29,11 @@
</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' >
@@ -94,14 +94,14 @@
</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>
diff --git a/doc/package/ebuild/helper_functions.docbook b/doc/package/ebuild/helper_functions.docbook
index 9c417afb..1a4737c5 100644
--- a/doc/package/ebuild/helper_functions.docbook
+++ b/doc/package/ebuild/helper_functions.docbook
@@ -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
@@ -33,18 +33,18 @@
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>
diff --git a/doc/package/ebuild/phases.docbook b/doc/package/ebuild/phases.docbook
index 383c605c..2cb1b444 100644
--- a/doc/package/ebuild/phases.docbook
+++ b/doc/package/ebuild/phases.docbook
@@ -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
@@ -40,13 +40,13 @@
</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>