[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members |
Date: |
Thu, 16 Mar 2017 07:27:30 +0100 |
Talking about #optional like this
# Note: fields are marked #optional to indicate that they may or may
# not appear ...
doesn't work so well in generated documentation, because the #optional
tag is not visible there. Replace by
# Note: optional members may or may not appear ...
Signed-off-by: Markus Armbruster <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
Message-Id: <address@hidden>
---
qapi/rocker.json | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 97e2b83..f374038 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -1,3 +1,5 @@
+# -*- Mode: Python -*-
+
##
# = Rocker switch device
##
@@ -137,8 +139,8 @@
#
# @ip-dst: #optional IP header destination address
#
-# Note: fields are marked #optional to indicate that they may or may not
-# appear in the flow key depending if they're relevant to the flow key.
+# Note: optional members may or may not appear in the flow key
+# depending if they're relevant to the flow key.
#
# Since: 2.4
##
@@ -167,8 +169,8 @@
#
# @ip-tos: #optional IP header TOS field
#
-# Note: fields are marked #optional to indicate that they may or may not
-# appear in the flow mask depending if they're relevant to the flow mask.
+# Note: optional members may or may not appear in the flow mask
+# depending if they're relevant to the flow mask.
#
# Since: 2.4
##
@@ -194,8 +196,8 @@
#
# @out-pport: #optional physical output port
#
-# Note: fields are marked #optional to indicate that they may or may not
-# appear in the flow action depending if they're relevant to the flow action.
+# Note: optional members may or may not appear in the flow action
+# depending if they're relevant to the flow action.
#
# Since: 2.4
##
@@ -288,8 +290,8 @@
#
# @ttl-check: #optional perform TTL check
#
-# Note: fields are marked #optional to indicate that they may or may not
-# appear in the group depending if they're relevant to the group type.
+# Note: optional members may or may not appear in the group depending
+# if they're relevant to the group type.
#
# Since: 2.4
##
--
2.7.4
- [Qemu-devel] [PULL for 2.9 03/49] qapi: Factor QAPISchemaParser._include() out of .__init__(), (continued)
- [Qemu-devel] [PULL for 2.9 03/49] qapi: Factor QAPISchemaParser._include() out of .__init__(), Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 06/49] docs/qapi-code-gen.txt: Drop confusing reference to 'gen', Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 10/49] tests/qapi-schema: Cover empty union base, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 11/49] qapi: Fix to reject empty union base gracefully, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 01/49] qapi2texi: change texi formatters, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 08/49] qapi: Have each QAPI schema declare its name rule violations, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 12/49] qapi2texi: Fix up output around #optional, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 04/49] qapi: Make doc comments optional where we don't need them, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 20/49] qapi: Use raw strings for regular expressions consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members,
Markus Armbruster <=
- [Qemu-devel] [PULL for 2.9 09/49] qapi: Clean up build of generated documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 27/49] qapi2texi: Include member type in generated documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 24/49] qapi2texi: Explain enum value undocumentedness more clearly, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 17/49] qapi: Conjure up QAPIDoc.ArgSection for undocumented members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/16