On 3/11/26 3:25 AM, Florian Hofhammer wrote:
This patch adds docstrings for typedefs and function declarations in
include/plugins/qemu-plugin.h that were previously missing. This
resolves inconsistencies in the docs, e.g., the description for
qemu_plugin_read_register() referring to qemu_plugin_register_flush_cb()
but code cache flush callbacks not being documented themselves.
Signed-off-by: Florian Hofhammer <[email protected]>
---
Hi,
While working on a QEMU plugin and browsing the online docs at
https://www.qemu.org/docs/master/devel/tcg-plugins.html, I noticed that
some of the API functions were not actually documented.
I went through the include/plugins/qemu-plugin.h header file and added
docstrings where they were missing, hoping of course that I documented
the correct functionality based on my understanding of the plugin
internals.
I hope that's useful and I didn't miss anything!
Best regards,
Florian
Changes in v3:
- Fix documentation build issue due to incorrect parameter name
- Link to v2:
https://lore.kernel.org/qemu-devel/[email protected]
Changes in v2:
- Added semantics clarification to the qemu_plugin_register_flush_cb()
docstring (suggested by Pierrick)
- Link to v1:
https://lore.kernel.org/qemu-devel/[email protected]
---
include/plugins/qemu-plugin.h | 106 +++++++++++++++++++++++++++++++++++++-----
1 file changed, 94 insertions(+), 12 deletions(-)
This was merged into master (c4c27695a14f7171a31e8c5d060d931bb1f37fef).
Thank you for your contribution!
Regards,
Pierrick
