For QMP commands with the oob flag set, insert a dummy feature ("pseudofeature") representing this behavior so that it can be documented.
Signed-off-by: John Snow <js...@redhat.com> --- docs/sphinx/qapidoc.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index e70a85a6403..81133b9b441 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -243,6 +243,12 @@ def _get_inline_target( # FIXME: Branches should be handled about here O:-) + # Pseudo-feature: document the OOB property. + if isinstance(ent, QAPISchemaCommand) and ent.allow_oob: + feat = QAPIDoc.ArgSection(ent.info, QAPIDoc.Kind.FEATURE, "allow-oob") + feat.append_line("This command supports `out-of-band execution`.") + sections.partitions[DocRegion.FEATURE].append(feat) + # Generated "returns" statement. if isinstance(ent, QAPISchemaCommand) and not any( s.kind == QAPIDoc.Kind.RETURNS -- 2.48.1