Auto-document qdev devices
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest4 patches 16 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/4 | qdev: Add a description field for qdev properties for documentationblock_int.h hw/ hw/ +73 more | +276 | 7 replies | |
| 2/4 | virtio-serial: Add description fields for qdev propertieshw/ hw/ | +23 | 4 replies | |
| 3/4 | net.h: Add description fields for qdev properitesnet.h | +8 | 0 replies | |
| 4/4 | block_int.h: Provide documentation for common block qdev propertiesblock_int.h | +12 | 0 replies |
Reviews trailers per patch
All 4 patches have a Reviewed-by or Acked-by.
| Patch | Markus Armbruster |
|---|---|
| 1/4 | A-b |
| 2/4 | A-b |
| 3/4 | A-b |
| 4/4 | A-b |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [Qemu-devel] [PATCH REBASE/RESEND 0/4] Auto-document qdev devices
Hello,
This is yet another rebase of the patchset I'd sent earlier.
The usual notes apply: this is just the start, just getting the framework in place and a few examples so that people can then pick up and start documenting their devices and options. We want to see all of the devices covered, and hopefully turn on build_bug_on() on an empty doc string.
Maintainers should perhaps also look for patches that introduce options without documentation.
That's the long-term goal (0.15-final). For short-term, I'll be preparing follow-on patches that add doc strings for a few more options and perhaps bug people based on git history as to what documentation is to be added for some options. Also to incorporate Markus's comments on beautifying output.
The earlier this patchset goes in the better since it'll reduce conflicts and rebases needed.
If this looks acceptable, please apply!
Amit Shah (4):
qdev: Add a description field for qdev properties for documentation
virtio-serial: Add description fields for qdev properties net.h: Add description fields for qdev properites block_int.h: Provide documentation for common block qdev properties
block_int.h | 20 +++++++----- hw/a9mpcore.c | 2 +- hw/acpi_piix4.c | 2 +- hw/apic.c | 4 +- hw/applesmc.c | 4 +- hw/arm11mpcore.c | 4 +- hw/arm_sysctl.c | 4 +- hw/armv7m.c | 2 +- hw/cs4231a.c | 6 ++-- hw/debugcon.c | 6 ++-- hw/eccmemctl.c | 2 +- hw/escc.c | 16 +++++----- hw/etraxfs_pic.c | 3 +- hw/fdc.c | 14 ++++---- hw/fw_cfg.c | 4 +- hw/grlib_apbuart.c | 2 +- hw/grlib_gptimer.c | 6 ++-- hw/grlib_irqmp.c | 4 +- hw/gus.c | 8 ++-- hw/hda-audio.c | 2 +- hw/hpet.c | 4 +- hw/i2c.c | 2 +- hw/ide/cmd646.c | 2 +- hw/ide/isa.c | 6 ++-- hw/ide/qdev.c | 6 ++-- hw/integratorcp.c | 2 +- hw/intel-hda.c | 6 ++-- hw/ioh3420.c | 8 ++-- hw/ivshmem.c | 15 +++++---- hw/lance.c | 2 +- hw/m48t59.c | 12 ++++---- hw/mc146818rtc.c | 2 +- hw/ne2000-isa.c | 4 +- hw/parallel.c | 8 ++-- hw/pci.c | 10 +++--- hw/pxa2xx_gpio.c | 4 +- hw/qdev-addr.h | 4 +- hw/qdev.c | 3 +- hw/qdev.h | 75 +++++++++++++++++++++++++---------------------- hw/s390-virtio-bus.c | 2 +- hw/sb16.c | 10 +++--- hw/scsi-bus.c | 2 +- hw/scsi-disk.c | 9 ++++-- hw/serial.c | 8 ++-- hw/slavio_timer.c | 2 +- hw/smbus_eeprom.c | 2 +- hw/sparc32_dma.c | 4 +- hw/spitz.c | 5 ++- hw/sun4m.c | 2 +- hw/sun4m_iommu.c | 2 +- hw/sun4u.c | 2 +- hw/syborg_fb.c | 4 +- hw/syborg_interrupt.c | 2 +- hw/syborg_keyboard.c | 2 +- hw/syborg_pointer.c | 4 +- hw/syborg_serial.c | 2 +- hw/syborg_timer.c | 2 +- hw/syborg_virtio.c | 6 ++-- hw/tcx.c | 10 +++--- hw/usb-bus.c | 2 +- hw/usb-msd.c | 2 +- hw/usb-ohci.c | 4 +- hw/usb-serial.c | 4 +- hw/virtio-blk.h | 4 +- hw/virtio-console.c | 19 +++++++---- hw/virtio-net.h | 51 ++++++++++++++++++++----------- hw/virtio-pci.c | 26 ++++++++-------- hw/virtio-serial.h | 13 ++++++++ hw/virtio.h | 2 +- hw/vt82c686.c | 2 +- hw/xilinx_ethlite.c | 6 ++- hw/xilinx_intc.c | 3 +- hw/xilinx_timer.c | 4 +- hw/xio3130_downstream.c | 8 ++-- hw/xio3130_upstream.c | 4 +- net.h | 12 +++++-- usb-linux.c | 8 ++-- 77 files changed, 301 insertions(+), 245 deletions(-)
Signature · 1 line
1.7.3.5