mirror of
https://github.com/qemu/qemu.git
synced 2025-07-29 23:18:25 +00:00
7faefad184
An object type's doc comment describes the type's members, less the ones defined in a named base type. Cases: * Struct: the members are defined in 'data' and inherited from 'base'. Since the base type cannot be implicit, the doc comment describes just 'data'. * Simple union: the only member is the implicit tag member @type, and the doc comment describes it. * Flat union with implicit base type: the members are defined in 'base', and the doc comment describes it. * Flat union with named base type: the members are inherited from 'base'. The doc comment describes no members. Before we can check a doc comment with .check_doc(), we need .connect_doc() connect each of its "argument sections" to the member it documents. For structs and simple unions, this is straightforward: the members in question are in .local_members, and .connect_doc() connects them. For flat unions with a named base type, it's trivial: .local_members is empty, and .connect_doc() does nothing. For flat unions with an implicit base type, it's tricky. We have QAPISchema._make_implicit_object_type() forward the union's doc comment to the implicit base type, so that the base type's .connect_doc() connects the members. The union's .connect_doc() does nothing, as .local_members is empty. Dirt effect: we check the doc comment twice, once for the union type, and once for the implicit base type. This is needlessly brittle and hard to understand. Clean up as follows. Make the union's .connect_doc() connect an implicit base's members itself. Do not forward the union's doc comment to its implicit base type. Requires extending .connect_doc() so it can work with a doc comment other than self.doc. Add an optional argument for that. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20191024110237.30963-11-armbru@redhat.com> |
||
|---|---|---|
| .. | ||
| coccinelle | ||
| kvm | ||
| modules | ||
| qapi | ||
| qemu-guest-agent | ||
| qemugdb | ||
| qmp | ||
| tracetool | ||
| travis | ||
| analyse-9p-simpletrace.py | ||
| analyse-locks-simpletrace.py | ||
| analyze-inclusions | ||
| analyze-migration.py | ||
| archive-source.sh | ||
| checkpatch.pl | ||
| clean-header-guards.pl | ||
| clean-includes | ||
| cleanup-trace-events.pl | ||
| cocci-macro-file.h | ||
| coverity-model.c | ||
| create_config | ||
| decodetree.py | ||
| device-crash-test | ||
| disas-objdump.pl | ||
| dump-guest-memory.py | ||
| extract-vsssdk-headers | ||
| feature_to_c.sh | ||
| fix-multiline-comments.sh | ||
| get_maintainer.pl | ||
| git-submodule.sh | ||
| git.orderfile | ||
| hxtool | ||
| make-release | ||
| minikconf.py | ||
| qapi-gen.py | ||
| qemu-binfmt-conf.sh | ||
| qemu-gdb.py | ||
| qemu-trace-stap | ||
| qemu-trace-stap.texi | ||
| refresh-pxe-roms.sh | ||
| render_block_graph.py | ||
| replay-dump.py | ||
| shaderinclude.pl | ||
| show-fixed-bugs.sh | ||
| signrom.py | ||
| simpletrace.py | ||
| switch-timer-api | ||
| tap-driver.pl | ||
| tap-merge.pl | ||
| texi2pod.pl | ||
| tracetool.py | ||
| update-linux-headers.sh | ||
| vmstate-static-checker.py | ||