[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 2/4] docs: add build infrastructure for gtkdocs
From: |
Avi Kivity |
Subject: |
Re: [Qemu-devel] [PATCH 2/4] docs: add build infrastructure for gtkdocs |
Date: |
Thu, 15 Dec 2011 11:37:29 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:8.0) Gecko/20111115 Thunderbird/8.0 |
On 12/14/2011 06:20 PM, Anthony Liguori wrote:
> By convention, documented headers now go in include/
Dislike.
> +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
Documentation should be built by default, so that errors in the format
are detected (and break the build).
>
> +
> +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
> +
Does this thing not support incremental builds?
> +++ b/QEMU-docs.xml
> @@ -0,0 +1,31 @@
> +<?xml version="1.0"?>
> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
> + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
> +[
> + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED
> 'http://www.w3.org/2003/XInclude'">
> +]>
> +<book id="index">
> + <bookinfo>
> + <title>QEMU Reference Manual</title>
> + <releaseinfo>
> + for QEMU 1.0.
1.1.
--
error compiling committee.c: too many arguments to function
[Qemu-devel] [PATCH 3/4] memory: update documentation to be in gtk-doc format, Anthony Liguori, 2011/12/14
[Qemu-devel] [PATCH 1/4] memory: make memory API parsable by gtkdoc-scan, Anthony Liguori, 2011/12/14