From d632b7bc0d9518d91ee0003d1a88ad43b259832e Mon Sep 17 00:00:00 2001
From: Zac Medico <zmedico@gentoo.org>
Date: Tue, 11 Dec 2007 21:32:44 +0000
Subject: 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
---
 doc/config/bashrc.docbook | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 doc/config/bashrc.docbook

(limited to 'doc/config')

diff --git a/doc/config/bashrc.docbook b/doc/config/bashrc.docbook
new file mode 100644
index 000000000..2f0626215
--- /dev/null
+++ b/doc/config/bashrc.docbook
@@ -0,0 +1,22 @@
+<chapter id='config-bashrc'>
+	<title>Bashrc Configuration</title>
+	<sect1 id='config-bashrc-locations'>
+		<title>bashrc locations</title>
+		<para>
+		If a bashrc file is located at <filename>/etc/portage/bashrc</filename>
+		then it will be sourced before an ebuild is executed.
+		</para>
+	</sect1>
+	<sect1 id='config-bashrc-ebuild-phase-hooks'>
+		<title>Ebuild Phase Hooks</title>
+		<para>
+		A phase hook function name begins with a pre_ or post_
+		prefix to indicate that it will be called before or after
+		one of the <link linkend='package-ebuild-phases'>ebuild phases</link>.
+		The prefix is followed by the name of the ebuild function that the hook
+		will be associated with. For example, a hook named pre_src_compile
+		will be called before src_compile, and a hook named post_src_compile
+		will be called after src_compile.
+		</para>
+	</sect1>
+</chapter>
-- 
cgit v1.2.3-1-g7c22