From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:59805) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RarZX-0003i0-6r for qemu-devel@nongnu.org; Wed, 14 Dec 2011 11:20:51 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RarZV-0003zj-I1 for qemu-devel@nongnu.org; Wed, 14 Dec 2011 11:20:47 -0500 Received: from cpe-70-123-132-139.austin.res.rr.com ([70.123.132.139]:40095 helo=localhost6.localdomain6) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RarZV-0003za-7p for qemu-devel@nongnu.org; Wed, 14 Dec 2011 11:20:45 -0500 From: Anthony Liguori Date: Wed, 14 Dec 2011 10:20:35 -0600 Message-Id: <1323879637-16901-3-git-send-email-aliguori@us.ibm.com> In-Reply-To: <1323879637-16901-1-git-send-email-aliguori@us.ibm.com> References: <1323879637-16901-1-git-send-email-aliguori@us.ibm.com> Subject: [Qemu-devel] [PATCH 2/4] docs: add build infrastructure for gtkdocs List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: Anthony Liguori , Avi Kivity By convention, documented headers now go in include/ Signed-off-by: Anthony Liguori --- Makefile | 6 +++++- Makefile.docs | 15 +++++++++++++++ QEMU-docs.xml | 31 +++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 1 deletions(-) create mode 100644 Makefile.docs create mode 100644 QEMU-docs.xml diff --git a/Makefile b/Makefile index 2c03055..d7974af 100644 --- a/Makefile +++ b/Makefile @@ -92,6 +92,8 @@ ifneq ($(wildcard config-host.mak),) include $(SRC_PATH)/Makefile.objs endif +include $(SRC_PATH)/Makefile.docs + $(common-obj-y): $(GENERATED_HEADERS) subdir-libcacard: $(oslib-obj-y) $(trace-obj-y) qemu-timer-common.o @@ -113,6 +115,8 @@ QEMU_CFLAGS+=$(CURL_CFLAGS) QEMU_CFLAGS+=$(GLIB_CFLAGS) +QEMU_CFLAGS+=$(SRC_PATH)/include + ui/cocoa.o: ui/cocoa.m ui/sdl.o audio/sdlaudio.o ui/sdl_zoom.o baum.o: QEMU_CFLAGS += $(SDL_CFLAGS) @@ -220,7 +224,7 @@ qemu-ga$(EXESUF): qemu-ga.o $(qga-obj-y) $(qapi-obj-y) $(tools-obj-y) $(qobject- QEMULIBS=libhw32 libhw64 libuser libdis libdis-user -clean: +clean: gtkdoc-clean # avoid old build problems by removing potentially incorrect old files rm -f config.mak op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h rm -f qemu-options.def diff --git a/Makefile.docs b/Makefile.docs new file mode 100644 index 0000000..bea0833 --- /dev/null +++ b/Makefile.docs @@ -0,0 +1,15 @@ +DOC_SRC=$(wildcard $(SRC_PATH)/include/*.h) + +gtkdoc: html/index.html + +html/index.html: $(DOC_SRC) + gtkdoc-scan --module=QEMU --source-dir=$(SRC_PATH)/include && \ + cp $(SRC_PATH)/QEMU-docs.xml . && \ + gtkdoc-mkdb --module=QEMU --output-format=xml --source-dir=$(SRC_PATH)/include && \ + mkdir -p html && \ + (cd html && gtkdoc-mkhtml QEMU ../QEMU-docs.xml && cd ..) && \ + gtkdoc-fixxref --module=QEMU --module-dir=html + +gtkdoc-clean: + $(RM) -r html xml + $(RM) $(SCAN_GEN) sgml.stamp *.bak html.stamp diff --git a/QEMU-docs.xml b/QEMU-docs.xml new file mode 100644 index 0000000..ddc827a --- /dev/null +++ b/QEMU-docs.xml @@ -0,0 +1,31 @@ + + +]> + + + QEMU Reference Manual + + for QEMU 1.0. + The latest version of this documentation can be found on-line at + http://wiki.qemu.org/docs-internal/. + + + + + Core Device APIs + + + + API Index + + + + Index of deprecated API + + + + + -- 1.7.4.1