summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorVictor Lowther <victor.lowther@gmail.com>2008-10-05 18:39:13 -0500
committerVictor Lowther <victor.lowther@gmail.com>2008-10-05 18:39:13 -0500
commit1fe13fe144d26cf827cc06b2ba164541cd4e29e9 (patch)
tree19567157e0851d74b69d87abc264f2d321feaf61 /man
parent226914884fba883682fa60a40bebb3873ecde927 (diff)
Document hook ordering convention in the pm-action man page.
Diffstat (limited to 'man')
-rw-r--r--man/pm-action.xml47
1 files changed, 44 insertions, 3 deletions
diff --git a/man/pm-action.xml b/man/pm-action.xml
index f1ec7a5..e1fa4bf 100644
--- a/man/pm-action.xml
+++ b/man/pm-action.xml
@@ -349,9 +349,9 @@
directory by putting a non-executable file in
/etc/pm/sleep.d, or by adding it to the HOOK_BLACKLIST
configuration variable.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><filename>/var/log/pm-suspend.log</filename></term>
<listitem>
@@ -362,6 +362,47 @@
</listitem>
</varlistentry>
</variablelist>
+ </refsect1>
+ <refsect1 id="sleep_hook_ordering_convention">
+ <title>SLEEP HOOK ORDERING CONVENTION</title>
+ <variablelist>
+ <varlistentry>
+ <term>00 - 49</term>
+ <listitem>
+ <para>User and most package supplied hooks. If a hook assumes
+ that all of the usual services and userspace
+ infrastructure is still running, it should be here.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>50 - 74</term>
+ <listitem>
+ <para> Service handling hooks. Hooks that start or stop a
+ service belong in this range. At or before 50, hooks
+ can assume that all services are still enabled.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>75 - 89</term>
+ <listitem>
+ <para> Module and non-core hardware handling. If a hook
+ needs to load/unload a module, or if it needs to
+ place non-video hardware that would otherwise break
+ suspend or hibernate into a safe state, it belongs in
+ this range. At or before 75, hooks can assume all
+ modules are still loaded.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>90 - 99</term>
+ <listitem>
+ <para> Reserved for critical suspend hooks. </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 id="config_vars">