document the stop hook

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com> Acked-by: Serge E. Hallyn <serge.hallyn@ubuntu.com>

document the stop hook
0a2b5ab1 · Wolfgang Bumiller · Stéphane Graber · b3286b62 · 0a2b5ab1
Commit 0a2b5ab1 authored Oct 06, 2015 by Wolfgang Bumiller Committed by Stéphane Graber Oct 07, 2015
Hide whitespace changes
Inline Side-by-side

Showing with 25 additions and 2 deletions

lxc.container.conf.sgml.in doc/lxc.container.conf.sgml.in +25 -2

No files found.
--- a/doc/lxc.container.conf.sgml.in
+++ b/doc/lxc.container.conf.sgml.in
@@ -1312,9 +1312,12 @@ mknod errno 0
          <listitem><para> Container name. </para></listitem>
          <listitem><para> Section (always 'lxc'). </para></listitem>
          <listitem><para> The hook type (i.e. 'clone' or 'pre-mount'). </para></listitem>
-          <listitem><para> Additional arguments In the
+          <listitem><para> Additional arguments. In the
          case of the clone hook, any extra arguments passed to
-          lxc-clone will appear as further arguments to the hook. </para></listitem>
+          lxc-clone will appear as further arguments to the hook.
+          In the case of the stop hook, paths to filedescriptors
+          for each of the container's namespaces along with their types
+          are passed. </para></listitem>
        </itemizedlist>
        The following environment variables are set:
        <itemizedlist>
@@ -1411,6 +1414,26 @@ mknod errno 0
      <variablelist>
        <varlistentry>
          <term>
+            <option>lxc.hook.stop</option>
+          </term>
+          <listitem>
+            <para>
+              A hook to be run in the host's namespace with references
+              to the container's namespaces after the container has been shut
+              down. For each namespace an extra argument is passed to the hook
+              containing the namespace's type and a filename that can be used to
+              obtain a file descriptor to the corresponding namespace, separated
+              by a colon. The type is the name as it would appear in the
+              <filename>/proc/PID/ns</filename> directory.
+              For instance for the mount namespace the argument usually looks
+              like <filename>mnt:/proc/PID/fd/12</filename>.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+      <variablelist>
+        <varlistentry>
+          <term>
            <option>lxc.hook.post-stop</option>
          </term>
          <listitem>