aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2020-10-09 12:15:42 -0400
committerMarkus Armbruster <armbru@redhat.com>2020-10-10 11:37:48 +0200
commit1a503761e451549ba7457848d3955bd3391438d6 (patch)
treeb529d94dcb5344221e56bb92f047ee5a1b858b54 /scripts
parentd1b21b393e7ae1a387a7c81f633d924a66d29408 (diff)
qapi/events.py: Move comments into docstrings
Clarify them while we're here. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Eduardo Habkost <ehabkost@redhat.com> Reviewed-by: Cleber Rosa <crosa@redhat.com> Message-Id: <20201009161558.107041-21-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts')
-rw-r--r--scripts/qapi/events.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py
index 57e0939e96..599f3d1f56 100644
--- a/scripts/qapi/events.py
+++ b/scripts/qapi/events.py
@@ -44,8 +44,12 @@ def gen_event_send_decl(name: str,
proto=build_event_send_proto(name, arg_type, boxed))
-# Declare and initialize an object 'qapi' using parameters from build_params()
def gen_param_var(typ: QAPISchemaObjectType) -> str:
+ """
+ Generate a struct variable holding the event parameters.
+
+ Initialize it with the function arguments defined in `gen_event_send`.
+ """
assert not typ.variants
ret = mcgen('''
%(c_name)s param = {