From 9a342dc14d405d041af40f76b8b9b7855fcda692 Mon Sep 17 00:00:00 2001
From: Zac Medico <zmedico@gentoo.org>
Date: Sun, 9 Dec 2007 05:50:48 +0000
Subject: Add some documentation for ebuild phases and pre/post phase hooks
 that can be defined via bashrc.

svn path=/main/trunk/; revision=8876
---
 doc/package/ebuild.docbook        |  4 ++++
 doc/package/ebuild/phases.docbook | 43 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 47 insertions(+)
 create mode 100644 doc/package/ebuild.docbook
 create mode 100644 doc/package/ebuild/phases.docbook

(limited to 'doc/package')

diff --git a/doc/package/ebuild.docbook b/doc/package/ebuild.docbook
new file mode 100644
index 000000000..5466f99db
--- /dev/null
+++ b/doc/package/ebuild.docbook
@@ -0,0 +1,4 @@
+<chapter id='package-ebuild'>
+<title>Ebuild</title>
+&package_ebuild_phases;
+</chapter>
diff --git a/doc/package/ebuild/phases.docbook b/doc/package/ebuild/phases.docbook
new file mode 100644
index 000000000..5c7f04969
--- /dev/null
+++ b/doc/package/ebuild/phases.docbook
@@ -0,0 +1,43 @@
+<sect1 id='package-ebuild-phases'>
+	<title>Ebuild Phases</title>
+	<para>
+	Ebuild execution is divided into a series of phases. In order
+	to implement a phase, an ebuild defines a function to serve as
+	an entry point for execution of that phase.
+	This design is similar to the template method pattern that
+	is commonly used in object oriented programming languages. An ebuild
+	can inherit or override a template method from an eclass.
+	</para>
+	<para>
+	The function names for the ebuild phases, listed in order of execution:
+	<itemizedlist>
+	<listitem>
+		pkg_setup
+	</listitem>
+	<listitem>
+		src_unpack
+	</listitem>
+	<listitem>
+		src_compile
+	</listitem>
+	<listitem>
+		src_test
+	</listitem>
+	<listitem>
+		src_install
+	</listitem>
+	<listitem>
+		pkg_preinst
+	</listitem>
+	<listitem>
+		pkg_postinst
+	</listitem>
+	<listitem>
+		pkg_prerm
+	</listitem>
+	<listitem>
+		pkg_postrm
+	</listitem>
+	</itemizedlist>
+	</para>
+</sect1>
-- 
cgit v1.2.3-1-g7c22