[lxc-devel] [PATCH] minor documentation fixes / clarification
Serge Hallyn
serge.hallyn at ubuntu.com
Tue Apr 9 03:25:24 UTC 2013
Quoting Dwight Engen (dwight.engen at oracle.com):
> Signed-off-by: Dwight Engen <dwight.engen at oracle.com>
>
Acked-by: Serge E. Hallyn <serge.hallyn at ubuntu.com>
Note i think your patch was linewrap-damaged. Could you resend
(with my ack) or post a github link?
> ---
> doc/legacy/lxc-ls.sgml.in | 4 ++--
> doc/lxc-execute.sgml.in | 8 ++++----
> doc/lxc-ps.sgml.in | 6 +++---
> doc/lxc-unshare.sgml.in | 6 +++---
> 4 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/doc/legacy/lxc-ls.sgml.in b/doc/legacy/lxc-ls.sgml.in
> index c04a4a4..60c085c 100644
> --- a/doc/legacy/lxc-ls.sgml.in
> +++ b/doc/legacy/lxc-ls.sgml.in
> @@ -50,7 +50,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> MA 02111-1307 USA <cmdsynopsis>
> <command>lxc-ls</command>
> <arg choice="opt">--active</arg>
> - <arg choice="opt">ls option</arg>
> + <arg choice="opt"><replaceable>ls options</replaceable></arg>
> </cmdsynopsis>
> </refsynopsisdiv>
>
> @@ -79,7 +79,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> MA 02111-1307 USA
> <varlistentry>
> <term>
> - <option><optional>ls options</optional></option>
> + <option><optional><replaceable>ls
> options</replaceable></optional></option> </term>
> <listitem>
> <para>
> diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
> index c83a5eb..de233f6 100644
> --- a/doc/lxc-execute.sgml.in
> +++ b/doc/lxc-execute.sgml.in
> @@ -132,12 +132,12 @@ Foundation, Inc., 59 Temple Place, Suite 330,
> Boston, MA 02111-1307 USA <para>
> Signal the end of options and disables further option
> processing. Any arguments after the -- are treated as
> - arguments.
> + arguments to <replaceable>command</replaceable>.
> </para>
> <para>
> - This option is useful when you want to execute, with the
> - command <command>lxc-execute</command>, a command line
> - with its own options.
> + This option is useful when you want specify options
> + to <replaceable>command</replaceable> and don't want
> + <command>lxc-execute</command> to interpret them.
> </para>
> </listitem>
> </varlistentry>
> diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in
> index f20bb02..b0103cf 100644
> --- a/doc/lxc-ps.sgml.in
> +++ b/doc/lxc-ps.sgml.in
> @@ -52,7 +52,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> MA 02111-1307 USA <arg choice="opt">--name
> <replaceable>name</replaceable></arg> <arg choice="opt">--lxc</arg>
> <arg choice="opt">--host</arg>
> - <arg choice="opt">-- ps option</arg>
> + <arg choice="opt">-- <replaceable>ps options</replaceable></arg>
> </cmdsynopsis>
> </refsynopsisdiv>
>
> @@ -69,7 +69,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> MA 02111-1307 USA the container associated to processes.
> </para>
> <para>
> - The additionnal specified ps options must not
> + The additional specified <replaceable>ps options</replaceable>
> must not remove the default ps header and the pid information,
> to be able to have the <command>lxc-ps</command> to find
> the container associated to processes.
> @@ -119,7 +119,7 @@ Foundation, Inc., 59 Temple Place, Suite 330,
> Boston, MA 02111-1307 USA
> <varlistentry>
> <term>
> - <option><optional>ps options</optional></option>
> + <option><optional><replaceable>ps
> options</replaceable></optional></option> </term>
> <listitem>
> <para>
> diff --git a/doc/lxc-unshare.sgml.in b/doc/lxc-unshare.sgml.in
> index 1fbaf0b..5c899b6 100644
> --- a/doc/lxc-unshare.sgml.in
> +++ b/doc/lxc-unshare.sgml.in
> @@ -49,7 +49,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> MA 02111-1307 USA
> <refsynopsisdiv>
> <cmdsynopsis>
> - <command>lxc-clone</command>
> + <command>lxc-unshare</command>
> <arg choice="req">-s <replaceable>namespaces</replaceable></arg>
> <arg choice="req">-u <replaceable>user</replaceable></arg>
> <arg choice="req">command</arg>
> @@ -115,7 +115,7 @@ Foundation, Inc., 59 Temple Place, Suite 330,
> Boston, MA 02111-1307 USA <para>
> To spawn a new shell with its own UTS (hostname) namespace,
> <programlisting>
> - lxc-clone -s UTSNAME /bin/bash
> + lxc-unshare -s UTSNAME /bin/bash
> </programlisting>
> If the hostname is changed in that shell, the change will not
> be reflected on the host.
> @@ -123,7 +123,7 @@ Foundation, Inc., 59 Temple Place, Suite 330,
> Boston, MA 02111-1307 USA <para>
> To spawn a shell in a new network, pid, and mount namespace,
> <programlisting>
> - lxc-clone -s "NETWORK|PID|MOUNT" /bin/bash
> + lxc-unshare -s "NETWORK|PID|MOUNT" /bin/bash
> </programlisting>
> The resulting shell will have pid 1 and will see no network
> interfaces. After re-mounting /proc in that shell,
> --
> 1.7.12.3
>
>
> ------------------------------------------------------------------------------
> Minimize network downtime and maximize team effectiveness.
> Reduce network management and security costs.Learn how to hire
> the most talented Cisco Certified professionals. Visit the
> Employer Resources Portal
> http://www.cisco.com/web/learning/employer_resources/index.html
> _______________________________________________
> Lxc-devel mailing list
> Lxc-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/lxc-devel
More information about the lxc-devel
mailing list