diff options
| author | Zac Medico <zmedico@gentoo.org> | 2007-12-11 21:32:44 +0000 |
|---|---|---|
| committer | Zac Medico <zmedico@gentoo.org> | 2007-12-11 21:32:44 +0000 |
| commit | d632b7bc0d9518d91ee0003d1a88ad43b259832e (patch) | |
| tree | 4da7135dabee210684e3a508715d3da366bc47ed /doc/package | |
| parent | e0838f94ba133bf6c514f84fe606f1b15956f6f9 (diff) | |
| download | portage-d632b7bc0d9518d91ee0003d1a88ad43b259832e.tar.gz portage-d632b7bc0d9518d91ee0003d1a88ad43b259832e.tar.bz2 portage-d632b7bc0d9518d91ee0003d1a88ad43b259832e.zip | |
Add some documentation for ebuild phases and pre/post phase
hooks that can be defined via bashrc. (trunk r8876)
svn path=/main/branches/2.1.2/; revision=8879
Diffstat (limited to 'doc/package')
| -rw-r--r-- | doc/package/ebuild.docbook | 4 | ||||
| -rw-r--r-- | doc/package/ebuild/phases.docbook | 43 |
2 files changed, 47 insertions, 0 deletions
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> |