Revision as of 17:45, 21 January 2019

Drafts

I'm saving some drafts here before including it on the wiki page. -Ehabkost (talk) 19:36, 16 January 2019 (UTC)

API documentation generation

Summary: Generation of API documentation from doc comments

QEMU currently has many functions documented using the GTK-Doc syntax, but there is no mechanism to actually generate API documentation from these doc comments. We need tools to generate API documentation from C and Python source code.

Links:

Details:

Skill level: beginner
Language: C, Python
Mentor: Eduardo Habkost <ehabkost@redhat.com> ("ehabkost" on IRC)
Suggested by: Eduardo Habkost

Guest ABI automated testing

Summary: Automated test of Guest ABI and compatibility

QEMU tries to provide a stable guest ABI on versioned machine-types. Despite investing lots of effort keeping compatibility, we have no automated testing to detect common bugs that break guest ABI. It should be possible to write automated test cases that will compare a virtual machine to a previously stored dump of guest ABI information, including:

CPUID data
Physical memory and I/O port maps
Device addresses (PCI, USB, etc.)
Device IDs or other readily available device information

This might require improving or adding new QMP commands and/or improving the qtest protocol, to provide information to be validated by the automated test case.

Links:

Details:

Skill level: intermediate
Language: C, Python
Mentor: Eduardo Habkost <ehabkost@redhat.com> ("ehabkost" on IRC)
Suggested by: Eduardo Habkost

@@ Line 43: / Line 43: @@
 '''Links:'''
-* TODO
+* [https://github.com/autotest/tp-qemu/tree/master/qemu/deps/cpuid Ancient test code for CPUID compatibility]
-* Wiki links to relevant material
+* [https://github.com/ehabkost/qemu-hacks/commits/work/guest-abi-tests incomplete proof of concept]
-* External links to mailing lists or web sites
 '''Details:'''