Patchwork doc: fix sheepdog invalid texi @table @list syntax

login
register
mail settings
Submitter Stefan Hajnoczi
Date Feb. 21, 2013, 9:13 a.m.
Message ID <1361438013-18995-1-git-send-email-stefanha@redhat.com>
Download mbox | patch
Permalink /patch/222212/
State New
Headers show

Comments

Stefan Hajnoczi - Feb. 21, 2013, 9:13 a.m.
Some versions of texinfo are not happy with @table @list:

  ./qemu-options.texi:1526: unknown command `list'
  ./qemu-options.texi:1526: table requires an argument: the formatter for @item
  ./qemu-options.texi:1526: warning: @table has text but no @item

Use @table @code instead and mark each line with @item.

Reported-by: Fred Bezies <fredbezies@gmail.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
Fred: Please test this patch to confirm it fixes the issue for you.

 qemu-options.hx | 19 +++++++------------
 1 file changed, 7 insertions(+), 12 deletions(-)
Stefan Hajnoczi - Feb. 21, 2013, 9:27 a.m.
On Thu, Feb 21, 2013 at 10:13:33AM +0100, Stefan Hajnoczi wrote:
> Some versions of texinfo are not happy with @table @list:
> 
>   ./qemu-options.texi:1526: unknown command `list'
>   ./qemu-options.texi:1526: table requires an argument: the formatter for @item
>   ./qemu-options.texi:1526: warning: @table has text but no @item
> 
> Use @table @code instead and mark each line with @item.
> 
> Reported-by: Fred Bezies <fredbezies@gmail.com>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
> Fred: Please test this patch to confirm it fixes the issue for you.
> 
>  qemu-options.hx | 19 +++++++------------
>  1 file changed, 7 insertions(+), 12 deletions(-)

Please ignore this patch, Cole Robinson already submitted an equivalent
fix:

http://patchwork.ozlabs.org/patch/222131/

Stefan
Stefan Hajnoczi - Feb. 21, 2013, 9:28 a.m.
On Thu, Feb 21, 2013 at 10:13:33AM +0100, Stefan Hajnoczi wrote:
> Some versions of texinfo are not happy with @table @list:
> 
>   ./qemu-options.texi:1526: unknown command `list'
>   ./qemu-options.texi:1526: table requires an argument: the formatter for @item
>   ./qemu-options.texi:1526: warning: @table has text but no @item
> 
> Use @table @code instead and mark each line with @item.
> 
> Reported-by: Fred Bezies <fredbezies@gmail.com>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
> Fred: Please test this patch to confirm it fixes the issue for you.
> 
>  qemu-options.hx | 19 +++++++------------
>  1 file changed, 7 insertions(+), 12 deletions(-)

NACK

(For the patch tracking scripts)

Stefan

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index 4bc9c85..3af60bf 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2095,18 +2095,13 @@  QEMU supports using either local sheepdog devices or remote networked
 devices.
 
 Syntax for specifying a sheepdog device
-@table @list
-``sheepdog:<vdiname>''
-
-``sheepdog:<vdiname>:<snapid>''
-
-``sheepdog:<vdiname>:<tag>''
-
-``sheepdog:<host>:<port>:<vdiname>''
-
-``sheepdog:<host>:<port>:<vdiname>:<snapid>''
-
-``sheepdog:<host>:<port>:<vdiname>:<tag>''
+@table @code
+@item sheepdog:<vdiname>
+@item sheepdog:<vdiname>:<snapid>
+@item sheepdog:<vdiname>:<tag>
+@item sheepdog:<host>:<port>:<vdiname>
+@item sheepdog:<host>:<port>:<vdiname>:<snapid>
+@item sheepdog:<host>:<port>:<vdiname>:<tag>
 @end table
 
 Example