From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=54069 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OvrES-0007DR-UC for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:37:02 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OvrER-0004mj-PW for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:37:00 -0400 Received: from mx1.redhat.com ([209.132.183.28]:5854) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OvrER-0004mf-JK for qemu-devel@nongnu.org; Wed, 15 Sep 2010 08:36:59 -0400 From: Amit Shah Date: Wed, 15 Sep 2010 18:06:48 +0530 Message-Id: Subject: [Qemu-devel] [PATCH 0/4] First steps towards documenting qdev devices/options List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Anthony Liguori Cc: Amit Shah , qemu list Hello, This is a rebase of the patchset I'd sent earlier. I add the 4/4 patch, documenting common block device properties. Other than that, 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 (over 0.14). 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. 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 | 14 +++++---- 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 | 10 +++--- hw/fw_cfg.c | 4 +- hw/gus.c | 8 ++-- 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/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 | 12 ++++---- 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 | 4 +- hw/serial.c | 8 ++-- hw/slavio_timer.c | 2 +- hw/smbus_eeprom.c | 2 +- hw/sparc32_dma.c | 2 +- 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-ohci.c | 4 +- hw/usb-serial.c | 12 ++++---- hw/vga-pci.c | 4 +- hw/virtio-blk.h | 4 +- hw/virtio-console.c | 19 ++++++++---- hw/virtio-net.h | 51 +++++++++++++++++++++------------ hw/virtio-pci.c | 22 +++++++------- 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 +- net.h | 9 ++++-- usb-linux.c | 8 ++-- 66 files changed, 266 insertions(+), 217 deletions(-) -- 1.7.2.2