qapi2texi: replace quotation by bold section name
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Fri, 17 Feb 2017 09:34:16 +0000 (13:34 +0400)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 20 Feb 2017 13:10:46 +0000 (14:10 +0100)
When we build qemu-qmp-ref.txt this causes texinfo to complain several
times:
"Negative repeat count does nothing at
/usr/share/texinfo/Texinfo/Convert/Line.pm line 124."

It also doesn't display correctly, because the "Notes" text disappears
entirely in the HTML version because it thinks there's no actual
quotation text.

The text file output formatting is also not good.

To solve those problems, remove usage of @quotation, and simply use bold
face for the section name.

Reported-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20170217093416.27688-1-marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
scripts/qapi2texi.py

index 83ded95c2dba29497743bfbd6e22e83d8065c40b..c1071c62c602476d156b1c85f59c0c6789a2647a 100755 (executable)
@@ -159,12 +159,10 @@ def texi_body(doc):
             func = texi_example
 
         if name:
-            # FIXME the indentation produced by @quotation in .txt and
-            # .html output is confusing
-            body += "\n@quotation %s\n%s\n@end quotation" % \
-                    (name, func(doc))
-        else:
-            body += func(doc)
+            # prefer @b over @strong, so txt doesn't translate it to *Foo:*
+            body += "\n\n@b{%s:}\n" % name
+
+        body += func(doc)
 
     return body