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 32 additions and 12 deletions
doc/lxc.conf.sgml.in
...@@ -668,26 +668,35 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -668,26 +668,35 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>
<option>proc:mixed</option> (or <option>proc</option>): <option>proc:mixed</option> (or <option>proc</option>):
mount <filename>/proc</filename> as read-write, but mount <filename>/proc</filename> as read-write, but
remount <filename>/proc/sys</filename> and remount <filename>/proc/sys</filename> and
<filename>/proc/sysrq-trigger</filename> read-only <filename>/proc/sysrq-trigger</filename> read-only
for security / container isolation purposes. for security / container isolation purposes.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>proc:rw</option>: mount <option>proc:rw</option>: mount
<filename>/proc</filename> as read-write <filename>/proc</filename> as read-write
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>sys:ro</option> (or <option>sys</option>): <option>sys:ro</option> (or <option>sys</option>):
mount <filename>/sys</filename> as read-only mount <filename>/sys</filename> as read-only
for security / container isolation purposes. for security / container isolation purposes.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>sys:rw</option>: mount <option>sys:rw</option>: mount
<filename>/sys</filename> as read-write <filename>/sys</filename> as read-write
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup:mixed</option> (or <option>cgroup:mixed</option> (or
<option>cgroup</option>): <option>cgroup</option>):
mount a tmpfs to <filename>/sys/fs/cgroup</filename>, mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
...@@ -698,21 +707,27 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -698,21 +707,27 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
The container will be able to write to its own The container will be able to write to its own
cgroup directory, but not the parents, since they cgroup directory, but not the parents, since they
will be remounted read-only will be remounted read-only
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup:ro</option>: similar to <option>cgroup:ro</option>: similar to
<option>cgroup:mixed</option>, but everything will <option>cgroup:mixed</option>, but everything will
be mounted read-only. be mounted read-only.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup:rw</option>: similar to <option>cgroup:rw</option>: similar to
<option>cgroup:mixed</option>, but everything will <option>cgroup:mixed</option>, but everything will
be mounted read-write. Note that the paths leading be mounted read-write. Note that the paths leading
up to the container's own cgroup will be writable, up to the container's own cgroup will be writable,
but will not be a cgroup filesystem but just part but will not be a cgroup filesystem but just part
of the tmpfs of <filename>/sys/fs/cgroup</filename> of the tmpfs of <filename>/sys/fs/cgroup</filename>
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup-full:mixed</option> (or <option>cgroup-full:mixed</option> (or
<option>cgroup-full</option>): <option>cgroup-full</option>):
mount a tmpfs to <filename>/sys/fs/cgroup</filename>, mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
...@@ -729,13 +744,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -729,13 +744,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
albeit read-only outside the container's own cgroup. albeit read-only outside the container's own cgroup.
This may leak quite a bit of information into the This may leak quite a bit of information into the
container. container.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup-full:ro</option>: similar to <option>cgroup-full:ro</option>: similar to
<option>cgroup-full:mixed</option>, but everything <option>cgroup-full:mixed</option>, but everything
will be mounted read-only. will be mounted read-only.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
<option>cgroup-full:rw</option>: similar to <option>cgroup-full:rw</option>: similar to
<option>cgroup-full:mixed</option>, but everything <option>cgroup-full:mixed</option>, but everything
will be mounted read-write. Note that in this case, will be mounted read-write. Note that in this case,
...@@ -743,6 +762,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ...@@ -743,6 +762,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
that if the container has CAP_SYS_ADMIN support that if the container has CAP_SYS_ADMIN support
and can mount the cgroup filesystem itself, it may and can mount the cgroup filesystem itself, it may
do so anyway.) 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