bwlp/qemu.git/docs/sphinx, branch spice_video_codecs

docs/sphinx: fix compatibility with sphinx < 1.8

2022-01-05T10:10:13+00:00

SphinxDirective was added with sphinx 1.8 (2018-09-13). Reported-by: Thomas Huth Signed-off-by: Marc-André Lureau Tested-by: Thomas Huth Message-Id: <20220104074649.1712440-1-marcandre.lureau@redhat.com> Signed-off-by: Thomas Huth

docs/sphinx: add sphinx modules to include D-Bus documentation

2021-12-21T06:50:21+00:00

Add a new dbus-doc directive to import D-Bus interfaces documentation from the introspection XML. The comments annotations follow the gtkdoc/kerneldoc style, and should be formatted with reST. Note: I realize after the fact that I was implementing those modules with sphinx 4, and that we have much lower requirements. Instead of lowering the features and code (removing type annotations etc), let's have a warning in the documentation when the D-Bus modules can't be used, and point to the source XML file in that case. Signed-off-by: Marc-André Lureau Acked-by: Gerd Hoffmann

docs/sphinx: add templates files to generated depfile

2021-11-08T08:27:23+00:00

Signed-off-by: Marc-André Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini

docs/sphinx: add static files to generated depfile

2021-11-08T08:27:23+00:00

Signed-off-by: Marc-André Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini

docs/sphinx: add loaded modules to generated depfile

2021-11-08T08:27:23+00:00

Signed-off-by: Marc-André Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini

qapidoc: introduce QAPISchemaIfCond.docgen()

2021-08-26T11:53:56+00:00

Instead of building the condition documentation from a list of string, use the result generated from QAPISchemaIfCond.docgen(). This changes the generated documentation from: - COND1, COND2... (where COND1, COND2 are Literal nodes, and ',' is Text) to: - COND1 and COND2 (the whole string as a Literal node) This will allow us to generate more complex conditions in the following patches, such as "(COND1 and COND2) or COND3". Adding back the differentiated formatting is left to the wish list. Signed-off-by: Marc-André Lureau Message-Id: <20210804083105.97531-6-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster [TODO comment added] Signed-off-by: Markus Armbruster

qapi: add QAPISchemaIfCond.is_present()

2021-08-26T11:53:56+00:00

Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20210804083105.97531-4-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster

qapi: wrap Sequence[str] in an object

2021-08-26T11:53:56+00:00

Mechanical change, except for a new assertion in QAPISchemaEntity.ifcond(). Signed-off-by: Marc-André Lureau Message-Id: <20210804083105.97531-3-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster [Rebased with obvious conflicts, commit message adjusted] Signed-off-by: Markus Armbruster

qapi/error: Repurpose QAPIError as an abstract base exception class

2021-04-30T10:59:54+00:00

Rename QAPIError to QAPISourceError, and then create a new QAPIError class that serves as the basis for all of our other custom exceptions, without specifying any class properties. This leaves QAPIError as a package-wide error class that's suitable for any current or future errors. (Right now, we don't have any errors that DON'T also want to specify a Source location, but this MAY change. In these cases, a common abstract ancestor would be desired.) Add docstrings to explain the intended function of each error class. Signed-off-by: John Snow Message-Id: <20210421192233.3542904-2-jsnow@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster

sphinx: qapidoc: Wrap "If" section body in a paragraph node

2021-04-13T09:14:58+00:00

These sections need to be wrapped in a block-level element, such as Paragraph in order for them to be rendered into Texinfo correctly. Before (e.g.):

If defined(CONFIG_REPLICATION)

became: .SS If \fBdefined(CONFIG_REPLICATION)\fP.SS \fBBlockdevOptionsReplication\fP (Object) ... After:

If defined(CONFIG_REPLICATION)

becomes: .SS If .sp \fBdefined(CONFIG_REPLICATION)\fP .SS \fBBlockdevOptionsReplication\fP (Object) ... Reported-by: Markus Armbruster Tested-by: Markus Armbruster Signed-off-by: John Snow Reviewed-by: Peter Maydell Message-id: 20210406141909.1992225-2-jsnow@redhat.com Signed-off-by: Peter Maydell