Re: [PATCH 4/5] docs/devel: split qom-api reference into new file

2023-06-20 Thread Philippe Mathieu-Daudé
On 20/6/23 12:03, Richard Henderson wrote: On 6/19/23 19:14, Alex Bennée wrote: +We don't currently generate the API documentation for QDEV due to QEMU +macros confusing the kerneldoc tool. For now see the headers in +``include/hw/qdev-core.h`` + +.. +  kernel-doc:: include/hw/qdev-core.h I'm

Re: [PATCH 4/5] docs/devel: split qom-api reference into new file

2023-06-20 Thread Richard Henderson
On 6/19/23 19:14, Alex Bennée wrote: +We don't currently generate the API documentation for QDEV due to QEMU +macros confusing the kerneldoc tool. For now see the headers in +``include/hw/qdev-core.h`` + +.. + kernel-doc:: include/hw/qdev-core.h I'm confused. Isn't that exactly what you're do

Re: [PATCH 4/5] docs/devel: split qom-api reference into new file

2023-06-19 Thread Philippe Mathieu-Daudé
On 19/6/23 19:14, Alex Bennée wrote: Lets try and keep the overview of the sub-system digestible by splitting the core API stuff into a separate file. As QOM and QDEV work together we should also try and enumerate the qdev_ functions. Currently this is a little broken as kerneldoc doesn't underst

[PATCH 4/5] docs/devel: split qom-api reference into new file

2023-06-19 Thread Alex Bennée
Lets try and keep the overview of the sub-system digestible by splitting the core API stuff into a separate file. As QOM and QDEV work together we should also try and enumerate the qdev_ functions. Currently this is a little broken as kerneldoc doesn't understand our macros. Signed-off-by: Alex Be