aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 00:19:01 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 00:19:01 +0000
commitea49bc09f8941d11bcc734859426d6553fbdcd24 (patch)
treea6481b1caaf4bb4d4cbde8d525d37e94556ffa5b
parent789e303b402aa71f9b952a5ebedbaff748d6c331 (diff)
downloadpaludis-ea49bc09f8941d11bcc734859426d6553fbdcd24.tar.gz
paludis-ea49bc09f8941d11bcc734859426d6553fbdcd24.tar.xz
Formatting
-rw-r--r--doc/configuration/hooks.html.part28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/configuration/hooks.html.part b/doc/configuration/hooks.html.part
index cbf129f..8d25c8a 100644
--- a/doc/configuration/hooks.html.part
+++ b/doc/configuration/hooks.html.part
@@ -102,9 +102,9 @@ following table indicates availability:</p>
<p>Where there is a choice, <code>.hook</code> hooks should be favoured over <code>.bash</code>
hooks.</p>
-<h3>Available Hooks</h3>
+<h2>Available Hooks</h2>
-<h4 id="general-hooks">General Hooks</h4>
+<h3 id="general-hooks">General Hooks</h3>
<p>The following general normal hooks are available:</p>
@@ -146,7 +146,7 @@ target. The <code>PALUDIS_CMDLINE</code> variables described below are also avai
<code>install_pretend_display_item</code> hooks, the <code>KIND</code> variable will also be of
interest.</p>
-<h4 id="ebuild-hooks">Ebuild Hooks</h4>
+<h3 id="ebuild-hooks">Ebuild Hooks</h3>
<p>The following ebuild hooks are available:</p>
@@ -205,7 +205,7 @@ interest.</p>
variable will contain the name of the hook being called. The
<code>PALUDIS_CMDLINE</code> variables described below are also available.</p>
-<h4 id="ebuild-message-hooks">Ebuild Message Hooks</h4>
+<h3 id="ebuild-message-hooks">Ebuild Message Hooks</h3>
<p>The following ebuild message hooks are available:</p>
@@ -221,7 +221,7 @@ being called, and the <code>MESSAGE</code> environment variable will contain
the message being passed to the function. The <code>PALUDIS_CMDLINE</code>
variables described below are also available.</p>
-<h4 id="merger-hooks">Merger / Unmerger Hooks</h4>
+<h3 id="merger-hooks">Merger / Unmerger Hooks</h3>
<p>The merger runs in two stages, for safety. First it checks that it can
probably install safely, then it does the actual install. Note that calculating
@@ -295,7 +295,7 @@ unmerger hooks are available:</p>
<p>The <code>UNLINK_TARGET</code> environment variable specifies the file about
to be unlinked, and <code>ROOT</code> is the filesystem root.</p>
-<h3>User Defined Hooks</h3>
+<h2>User Defined Hooks</h2>
<p>User defined hooks should be executable (<code>chmod a+x</code>) scripts named
<code>*.bash</code> or <code>*.hook</code>. They can live in two locations (or
@@ -313,12 +313,12 @@ be symlinked there, to allow a single script to be shared between hooks):</p>
systems, <code><em>LIBDIR</em></code> is <code>/usr/lib</code> or <code>/usr/lib64</code>.</li>
</ul>
-<h4 id="bash-hooks">Bash Hooks</h4>
+<h3 id="bash-hooks">Bash Hooks</h3>
<p>A <code>.bash</code> hook is merely executed when the associated action is
triggered. There is no guarantee as to execution order.</p>
-<h4 id="hook-hooks">Hook Hooks</h4>
+<h3 id="hook-hooks">Hook Hooks</h3>
<p>A <code>.hook</code> hook is more powerful. It must not run anything in
global scope, but instead defines all its actions in functions. It must, at
@@ -367,7 +367,7 @@ hook_after_install_all_post()
are cached, and are generally only called once per session, so the output should
not vary based upon outside parameters.</p>
-<h4 id="py-hooks">Python Hooks</h4>
+<h3 id="py-hooks">Python Hooks</h3>
<p>A <code>.py</code> hook is much like <code>.hook</code> hook, but written
in Python and with full access to the current Paludis environment through
@@ -399,7 +399,7 @@ def hook_after_install_all_post(hook_env):
return ["check_for_rabbits", "check_for_squirrels"]
</pre>
-<h4 id="so-hooks">So Hooks</h4>
+<h3 id="so-hooks">So Hooks</h3>
<p>A <code>.so</code> hook is written in C++ and has full access to the Paludis public API.
The hook takes the form of a shared library with a filename ending in <code>.so.<i>N</i></code>,
@@ -420,7 +420,7 @@ declared in the header <code>&lt;paludis/hook.hh&gt;</code>, including any neces
<dd>The usual <code>Environment</code>, as used by all Paludis clients.</dd>
<dt><code>const paludis::Hook &amp;</code></dt>
<dd>Contains information about the hook being called. In <code>paludis_hook_add_dependencies</code>,
-the only useful member is <code>name()</code>.
+the only useful member is <code>name()</code>.</dd>
<dt><code>paludis::DirectedGraph&lt;std::string, int&gt; &amp;</code></dt>
<dd>A graph containing, as nodes, all named hooks that will be executed along with
this one. The <code>paludis_hook_add_dependencies</code> function should add any
@@ -434,20 +434,20 @@ containing any information that should be passed back to the hook's caller (only
used if the <code>Hook</code>'s <code>output_dest</code> member is <code>hod_grab</code>).</dd>
</dl>
-<h3>Package Manager Defined Hooks</h3>
+<h2>Package Manager Defined Hooks</h2>
<p>Paludis places some of its own hooks in
<code><em>LIBEXECDIR</em>/hooks/<em>hookname</em></code>. These directories are
not for end user use.</p>
-<h3>Example Hooks</h3>
+<h2>Example Hooks</h2>
<p>Paludis ships certain example hooks that many users would find useful, but that
are not suitably general to be enabled by default -- these live in
<code>DATADIR/paludis/hooks/demos/</code>. You may also find the default
hooks useful -- these live in various places in <code>LIBEXECDIR/paludis/hooks/</code>.</p>
-<h3>The <code>PALUDIS_CMDLINE</code> Variables</h3>
+<h2>The <code>PALUDIS_CMDLINE</code> Variables</h2>
<p>Sometimes hooks need access to the commandline used to invoke
<code>paludis</code>. However, manual parsing of the commandline by hooks will