[lxc-devel] [PATCH] doc: Fix the description of -n option in lxc-info(1)

[Stéphane Graber]

On Tue, Dec 24, 2013 at 03:56:23PM +0900, KATOH Yasufumi wrote:
> Commit 5444216 revised -n option from allowing to specify multiple
> containers using regex to specifying only one container. But
> lxc-info(1) remains original. so
> - mark -n required
> - remove the description of -n that is included in common options
> 
> Signed-off-by: KATOH Yasufumi <karma at jazz.email.ne.jp>

Acked-by: Stéphane Graber <stgraber at ubuntu.com>

> ---
>  doc/ja/lxc-info.sgml.in | 33 +++------------------------------
>  doc/lxc-info.sgml.in    | 26 +++-----------------------
>  2 files changed, 6 insertions(+), 53 deletions(-)
> 
> diff --git a/doc/ja/lxc-info.sgml.in b/doc/ja/lxc-info.sgml.in
> index c004814..19d97c2 100644
> --- a/doc/ja/lxc-info.sgml.in
> +++ b/doc/ja/lxc-info.sgml.in
> @@ -53,7 +53,7 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
>    <refsynopsisdiv>
>      <cmdsynopsis>
>        <command>lxc-info</command>
> -      <arg choice="opt">-n <replaceable>name</replaceable></arg>
> +      <arg choice="req">-n <replaceable>name</replaceable></arg>
>        <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
>        <arg choice="opt">-s</arg>
>        <arg choice="opt">-p</arg>
> @@ -67,8 +67,8 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
>      <title><!-- Description -->説明</title>
>      <para>
>        <!--
> -      <command>lxc-info</command> queries and shows information about
> -      containers.
> +      <command>lxc-info</command> queries and shows information about a
> +      container.
>        -->
>        <command>lxc-info</command> は，コンテナに関する情報を問い合わせ，表示します．
>      </para>
> @@ -80,33 +80,6 @@ by KATOH Yasufumi <karma at jazz.email.ne.jp>
>  
>        <varlistentry>
>          <term>
> -          <option><optional>-n <replaceable>name</replaceable></optional></option>
> -        </term>
> -        <listitem>
> -          <para>
> -            <!--
> -            The container name. It is interpreted as a regular expression,
> -            so it is possible to get information on all containers, several
> -            of them or just one. See
> -            <citerefentry>
> -             <refentrytitle><command>regex</command></refentrytitle>
> -	     <manvolnum>7</manvolnum>
> -            </citerefentry> for regular expression syntax. If not specified,
> -            <replaceable>name</replaceable> will default to '.*' which
> -            will give information on all containers in
> -            <command>lxcpath</command>.
> -            -->
> -            コンテナ名．正規表現として解釈され，全てのコンテナ，指定したいくつかのコンテナ，特定のコンテナのいずれかの情報を取得できます．正規表現については
> -            <citerefentry>
> -             <refentrytitle><command>regex</command></refentrytitle>
> -	     <manvolnum>7</manvolnum>
> -            </citerefentry> を参照してください．もし指定しなければ，<replaceable>name</replaceable> はデフォルトで <command>lxcpath</command> に存在する全てのコンテナの情報を取得する '.*' を指定したことになります．
> -          </para>
> -        </listitem>
> -      </varlistentry>
> -
> -      <varlistentry>
> -        <term>
>            <option><optional>-c <replaceable>KEY</replaceable></optional></option>
>          </term>
>          <listitem>
> diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in
> index 5f99994..af93d94 100644
> --- a/doc/lxc-info.sgml.in
> +++ b/doc/lxc-info.sgml.in
> @@ -47,7 +47,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>    <refsynopsisdiv>
>      <cmdsynopsis>
>        <command>lxc-info</command>
> -      <arg choice="opt">-n <replaceable>name</replaceable></arg>
> +      <arg choice="req">-n <replaceable>name</replaceable></arg>
>        <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
>        <arg choice="opt">-s</arg>
>        <arg choice="opt">-p</arg>
> @@ -60,8 +60,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>    <refsect1>
>      <title>Description</title>
>      <para>
> -      <command>lxc-info</command> queries and shows information about
> -      containers.
> +      <command>lxc-info</command> queries and shows information about a
> +      container.
>      </para>
>    </refsect1>
>  
> @@ -71,26 +71,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>  
>        <varlistentry>
>          <term>
> -          <option><optional>-n <replaceable>name</replaceable></optional></option>
> -        </term>
> -        <listitem>
> -          <para>
> -            The container name. It is interpreted as a regular expression,
> -            so it is possible to get information on all containers, several
> -            of them or just one. See
> -            <citerefentry>
> -             <refentrytitle><command>regex</command></refentrytitle>
> -	     <manvolnum>7</manvolnum>
> -            </citerefentry> for regular expression syntax. If not specified,
> -            <replaceable>name</replaceable> will default to '.*' which
> -            will give information on all containers in
> -            <command>lxcpath</command>.
> -          </para>
> -        </listitem>
> -      </varlistentry>
> -
> -      <varlistentry>
> -        <term>
>            <option><optional>-c <replaceable>KEY</replaceable></optional></option>
>          </term>
>          <listitem>
> -- 
> 1.8.4.4
> 
> _______________________________________________
> lxc-devel mailing list
> lxc-devel at lists.linuxcontainers.org
> http://lists.linuxcontainers.org/listinfo/lxc-devel

-- 
Stéphane Graber
Ubuntu developer
http://www.ubuntu.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20131224/f31db295/attachment.pgp>