>From 130c817790880c61b79dbccf66f5863c406eb7d4 Mon Sep 17 00:00:00 2001 From: Anthony Liguori Date: Thu, 12 May 2011 10:56:29 -0500 Subject: [PATCH] qdev: add centralized documentation for qdev This is mostly a proof-of-concept. Signed-off-by: Anthony Liguori diff --git a/Makefile b/Makefile index 2b0438c..fddb261 100644 --- a/Makefile +++ b/Makefile @@ -341,5 +341,7 @@ tarbin: $(mandir)/man1/qemu-img.1 \ $(mandir)/man8/qemu-nbd.8 +include $(SRC_PATH)/Makefile.doc + # Include automatically generated dependency files -include $(wildcard *.d audio/*.d slirp/*.d block/*.d net/*.d ui/*.d) diff --git a/Makefile.doc b/Makefile.doc new file mode 100644 index 0000000..f769b23 --- /dev/null +++ b/Makefile.doc @@ -0,0 +1,2 @@ +qdev-doc.html: $(SRC_PATH)/qdev-doc.json + python $(SRC_PATH)/scripts/qdev-doc-to-html.py < $< > $@ diff --git a/qdev-doc.json b/qdev-doc.json new file mode 100644 index 0000000..c24630b --- /dev/null +++ b/qdev-doc.json @@ -0,0 +1,14 @@ +# -*- Mode: Python -*- + +[ { "device": "isa-serial", + "parent": "ISADevice", + "properties": { + "index": { "type": "uint32", + "doc": "A value from 0-3 that describes which IO regions to expose the device on. This sets appropriate values for iobase and irq." }, + "iobase": { "type": "hex32", + "doc": "The base IO address to expose the device on." }, + "irq": { "type": "uint32", + "doc": "The IRQ to use for the device." }, + "chardev": { "type": "chr", + "doc": "The name of a character device to specify." } } } + ] diff --git a/scripts/qdev-doc-to-html.py b/scripts/qdev-doc-to-html.py new file mode 100644 index 0000000..a25fe35 --- /dev/null +++ b/scripts/qdev-doc-to-html.py @@ -0,0 +1,40 @@ +#!/usr/bin/python + +import sys + +data = sys.stdin.read() + +docs = eval(data) + +sys.stdout.write(''' + + +QEMU device documentation + + +''') + +for item in docs: + sys.stdout.write(''' +

%(device)s :: %(parent)s

+ + + + + +''' % item) + for prop in item["properties"]: + sys.stdout.write(''' + + + +''' % (prop, item["properties"][prop]['type'], item["properties"][prop]['doc'])) + + sys.stdout.write(''' +
NameTypeComments
%s%s%s
+''') + +sys.stdout.write(''' + + +''') -- 1.7.4.1