diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:56:59 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:02 +0100 |
| commit | 42bebcc129a8bf235f41d65788eb54e199ba5e64 (patch) | |
| tree | e211c4d5208bbcedc9a53b84758e06d02558e98b | |
| parent | 481537451302fc63eee5cf3663a92629bb78954f (diff) | |
qapi2texi: Fix up output around #optional
We use tag #optional to mark optional members, like this:
# @name: #optional The name of the guest
texi_body() strips #optional, but not whitespace around it. For the
above, we get in qemu-qmp-qapi.texi
@item @code{'name'} (optional)
The name of the guest
@end table
The extra space can lead to artifacts in output, e.g in
qemu-qmp-ref.7.pod
=item C<'name'> (optional)
The name of the guest
and then in qemu-qmp-ref.7
.IX Item "name (optional)"
.Vb 1
\& The name of the guest
.Ve
instead of intended plain
.IX Item "name (optional)"
The name of the guest
Get rid of these artifacts by removing whitespace around #optional
along with it.
This turns three minus signs in qapi-schema.json into markup, because
they're now at the beginning of the line. Drop them, they're unwanted
there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1489582656-31133-11-git-send-email-armbru@redhat.com>
| -rw-r--r-- | qapi-schema.json | 6 | ||||
| -rwxr-xr-x | scripts/qapi2texi.py | 3 |
2 files changed, 5 insertions, 4 deletions
diff --git a/qapi-schema.json b/qapi-schema.json index 17c766ee3b..52141cd51e 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -3779,11 +3779,11 @@ # # @dstport: #optional destination port - mandatory for udp, optional for ip # -# @ipv6: #optional - force the use of ipv6 +# @ipv6: #optional force the use of ipv6 # -# @udp: #optional - use the udp version of l2tpv3 encapsulation +# @udp: #optional use the udp version of l2tpv3 encapsulation # -# @cookie64: #optional - use 64 bit coookies +# @cookie64: #optional use 64 bit coookies # # @counter: #optional have sequence counter # diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 06d6abfa5a..0f3e5738c8 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -137,7 +137,8 @@ def texi_body(doc): desc = str(section) opt = '' if "#optional" in desc: - desc = desc.replace("#optional", "") + desc = re.sub(r'^ *#optional *\n?|\n? *#optional *$|#optional', + '', desc) opt = ' (optional)' body += "@item @code{'%s'}%s\n%s\n" % (arg, opt, texi_format(desc)) |