Skip to content

L
lxc
Commit 3157e673 by Dwight Engen Committed by Serge Hallyn
Options

fix errors when using docbook2man

docbook2man picks up some errors that docbook2x does not, fixing them isn't harmful to docbook2x. The only real change is adding <para> and <citerefentry> tags. Signed-off-by: 's avatarDwight Engen <dwight.engen@oracle.com> Signed-off-by: 's avatarSerge Hallyn <serge.hallyn@ubuntu.com>
parent 5e00ff01
Showing with 88 additions and 68 deletions
doc/lxc.conf.sgml.in
...@@ -668,81 +668,101 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -668,81 +668,101 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<option>proc:mixed</option> (or <option>proc</option>): <para>
mount <filename>/proc</filename> as read-write, but <option>proc:mixed</option> (or <option>proc</option>):
remount <filename>/proc/sys</filename> and mount <filename>/proc</filename> as read-write, but
<filename>/proc/sysrq-trigger</filename> read-only remount <filename>/proc/sys</filename> and
for security / container isolation purposes. <filename>/proc/sysrq-trigger</filename> read-only
for security / container isolation purposes.
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>proc:rw</option>: mount <para>
<filename>/proc</filename> as read-write <option>proc:rw</option>: mount
<filename>/proc</filename> as read-write
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>sys:ro</option> (or <option>sys</option>): <para>
mount <filename>/sys</filename> as read-only <option>sys:ro</option> (or <option>sys</option>):
for security / container isolation purposes. mount <filename>/sys</filename> as read-only
for security / container isolation purposes.
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>sys:rw</option>: mount <para>
<filename>/sys</filename> as read-write <option>sys:rw</option>: mount
<filename>/sys</filename> as read-write
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup:mixed</option> (or <para>
<option>cgroup</option>): <option>cgroup:mixed</option> (or
mount a tmpfs to <filename>/sys/fs/cgroup</filename>, <option>cgroup</option>):
create directories for all hierarchies to which mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
the container is added, create subdirectories create directories for all hierarchies to which
there with the name of the cgroup, and bind-mount the container is added, create subdirectories
the container's own cgroup into that directory. there with the name of the cgroup, and bind-mount
The container will be able to write to its own the container's own cgroup into that directory.
cgroup directory, but not the parents, since they The container will be able to write to its own
will be remounted read-only cgroup directory, but not the parents, since they
will be remounted read-only
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup:ro</option>: similar to <para>
<option>cgroup:mixed</option>, but everything will <option>cgroup:ro</option>: similar to
<option>cgroup:mixed</option>, but everything will
be mounted read-only. be mounted read-only.
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup:rw</option>: similar to <para>
<option>cgroup:mixed</option>, but everything will <option>cgroup:rw</option>: similar to
be mounted read-write. Note that the paths leading <option>cgroup:mixed</option>, but everything will
up to the container's own cgroup will be writable, be mounted read-write. Note that the paths leading
but will not be a cgroup filesystem but just part up to the container's own cgroup will be writable,
of the tmpfs of <filename>/sys/fs/cgroup</filename> but will not be a cgroup filesystem but just part
of the tmpfs of <filename>/sys/fs/cgroup</filename>
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup-full:mixed</option> (or <para>
<option>cgroup-full</option>): <option>cgroup-full:mixed</option> (or
mount a tmpfs to <filename>/sys/fs/cgroup</filename>, <option>cgroup-full</option>):
create directories for all hierarchies to which mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
the container is added, bind-mount the hierarchies create directories for all hierarchies to which
from the host to the container and make everything the container is added, bind-mount the hierarchies
read-only except the container's own cgroup. Note from the host to the container and make everything
that compared to <option>cgroup</option>, where read-only except the container's own cgroup. Note
all paths leading up to the container's own cgroup that compared to <option>cgroup</option>, where
are just simple directories in the underlying all paths leading up to the container's own cgroup
tmpfs, here are just simple directories in the underlying
<filename>/sys/fs/cgroup/$hierarchy</filename> tmpfs, here
will contain the host's full cgroup hierarchy, <filename>/sys/fs/cgroup/$hierarchy</filename>
albeit read-only outside the container's own cgroup. will contain the host's full cgroup hierarchy,
This may leak quite a bit of information into the albeit read-only outside the container's own cgroup.
container. This may leak quite a bit of information into the
container.
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup-full:ro</option>: similar to <para>
<option>cgroup-full:mixed</option>, but everything <option>cgroup-full:ro</option>: similar to
will be mounted read-only. <option>cgroup-full:mixed</option>, but everything
will be mounted read-only.
</para>
</listitem> </listitem>
<listitem> <listitem>
<option>cgroup-full:rw</option>: similar to <para>
<option>cgroup-full:mixed</option>, but everything <option>cgroup-full:rw</option>: similar to
will be mounted read-write. Note that in this case, <option>cgroup-full:mixed</option>, but everything
the container may escape its own cgroup. (Note also will be mounted read-write. Note that in this case,
that if the container has CAP_SYS_ADMIN support the container may escape its own cgroup. (Note also
and can mount the cgroup filesystem itself, it may that if the container has CAP_SYS_ADMIN support
do so anyway.) and can mount the cgroup filesystem itself, it may
do so anyway.)
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
...@@ -1001,20 +1021,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -1001,20 +1021,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
as command line arguments and through environment variables. as command line arguments and through environment variables.
The arguments are: The arguments are:
<itemizedlist> <itemizedlist>
<listitem> Container name. </listitem> <listitem><para> Container name. </para></listitem>
<listitem> Section (always 'lxc'). </listitem> <listitem><para> Section (always 'lxc'). </para></listitem>
<listitem> The hook type (i.e. 'clone' or 'pre-mount'). </listitem> <listitem><para> The hook type (i.e. 'clone' or 'pre-mount'). </para></listitem>
<listitem> Additional arguments In the <listitem><para> Additional arguments In the
case of the clone hook, any extra arguments passed to case of the clone hook, any extra arguments passed to
lxc-clone will appear as further arguments to the hook. </listitem> lxc-clone will appear as further arguments to the hook. </para></listitem>
</itemizedlist> </itemizedlist>
The following environment variables are set: The following environment variables are set:
<itemizedlist> <itemizedlist>
<listitem> LXC_NAME: is the container's name. </listitem> <listitem><para> LXC_NAME: is the container's name. </para></listitem>
<listitem> LXC_ROOTFS_MOUNT: the path to the mounted root filesystem. </listitem> <listitem><para> LXC_ROOTFS_MOUNT: the path to the mounted root filesystem. </para></listitem>
<listitem> LXC_CONFIG_FILE: the path to the container configuration file. </listitem> <listitem><para> LXC_CONFIG_FILE: the path to the container configuration file. </para></listitem>
<listitem> LXC_SRC_NAME: in the case of the clone hook, this is the original container's name. </listitem> <listitem><para> LXC_SRC_NAME: in the case of the clone hook, this is the original container's name. </para></listitem>
<listitem> LXC_ROOTFS_PATH: this is the lxc.rootfs entry for the container. Note this is likely not where the mounted rootfs is to be found, use LXC_ROOTFS_MOUNT for that. </listitem> <listitem><para> LXC_ROOTFS_PATH: this is the lxc.rootfs entry for the container. Note this is likely not where the mounted rootfs is to be found, use LXC_ROOTFS_MOUNT for that. </para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
...@@ -1121,8 +1141,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -1121,8 +1141,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<listitem> <listitem>
<para> <para>
A hook to be run when the container is cloned to a new one. A hook to be run when the container is cloned to a new one.
See <refentrytitle><command>lxc-clone</command></refentrytitle> See <citerefentry><refentrytitle><command>lxc-clone</command></refentrytitle>
<manvolnum>1</manvolnum> for more information. <manvolnum>1</manvolnum></citerefentry> for more information.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment