[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and memb
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting |
Date: |
Thu, 16 Mar 2017 07:27:38 +0100 |
Use @code{%s} instead of @code{'%s'}. Impact, using @id as example:
* Texinfo
address@hidden @code{'id'}
address@hidden @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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
---
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
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, (continued)
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType', Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting,
Markus Armbruster <=
- [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 46/49] qapi: union_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 45/49] qapi: struct_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 38/49] tests/qapi-schema: Improve coverage of bogus member docs, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 16/49] qapi: Prepare for requiring more complete documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 44/49] qapi: enum_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/16