[v1] qapi: Put type information back into QMP documentation

[Qemu-devel] [PATCH for-2.9 20/47] qapi2texi: Plainer enum value and member name formatting

Posted by Markus Armbruster 8 years, 7 months ago

Use @code{%s} instead of @code{'%s'}.  Impact, using @id as example:

* Texinfo
  -@item @code{'id'}
  +@item @code{id}

* HTML
  -<dt><code>'id'</code></dt>
  +<dt><code>id</code></dt>

* POD (for manual pages):
  -=item C<'id'>
  +=item C<id>

* Formatted manual pages:
  -'id'
  +"id"

* Plain text:
  -     ''id''
  +     'id'

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi2texi.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py
index 91cd593..ecfaeda 100755
--- a/scripts/qapi2texi.py
+++ b/scripts/qapi2texi.py
@@ -130,12 +130,12 @@ def texi_body(doc):
 
 def texi_enum_value(value):
     """Format a table of members item for an enumeration value"""
-    return "@item @code{'%s'}\n" % value.name
+    return '@item @code{%s}\n' % value.name
 
 
 def texi_member(member):
     """Format a table of members item for an object type member"""
-    return "@item @code{'%s'}%s\n" % (
+    return '@item @code{%s}%s\n' % (
         member.name, ' (optional)' if member.optional else '')
 
 
-- 
2.7.4

Re: [Qemu-devel] [PATCH for-2.9 20/47] qapi2texi: Plainer enum value and member name formatting

Posted by Eric Blake 8 years, 7 months ago

On 03/13/2017 01:18 AM, Markus Armbruster wrote:
> Use @code{%s} instead of @code{'%s'}.  Impact, using @id as example:
> 
> * Texinfo
>   -@item @code{'id'}
>   +@item @code{id}
> 
> * HTML
>   -<dt><code>'id'</code></dt>
>   +<dt><code>id</code></dt>
> 
> * POD (for manual pages):
>   -=item C<'id'>
>   +=item C<id>
> 
> * Formatted manual pages:
>   -'id'
>   +"id"
> 
> * Plain text:
>   -     ''id''
>   +     'id'
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  scripts/qapi2texi.py | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org