From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=40240 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PpNW7-0006fP-2o for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:12:45 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PpNW3-0001Fr-T7 for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:12:42 -0500 Received: from mail-qw0-f45.google.com ([209.85.216.45]:47731) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PpNW3-0001Ff-KW for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:12:39 -0500 Received: by qwk4 with SMTP id 4so268729qwk.4 for ; Tue, 15 Feb 2011 08:12:39 -0800 (PST) Message-ID: <4D5AA5E7.40203@codemonkey.ws> Date: Tue, 15 Feb 2011 10:12:23 -0600 From: Anthony Liguori MIME-Version: 1.0 Subject: Re: [Qemu-devel] [PATCH REBASE/RESEND 0/4] Auto-document qdev devices References: In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Amit Shah Cc: qemu list , Markus Armbruster On 02/04/2011 12:18 AM, Amit Shah wrote: > 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! > I think we need to approach this in such a way that we generate not only inline documentation but out of line documentation. We need a way to extract the docs into a file. That could mean having something like a .hx file or just doing some clever things with grep DEFINE_PROP. Regards, Anthony Liguori > 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(-) > >