[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2)
From: |
Anthony Liguori |
Subject: |
[Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2) |
Date: |
Wed, 14 Dec 2011 14:01:10 -0600 |
This series integrates GTK-DOC into our build process via a gtkdoc build target.
This is to provide internal API documentation in a more accessible format. Once
this gets merged into the tree, I'll add a nightly cron job on qemu.org so that
there is always a copy of the latest internal API documentation on the website.
I've posted the output of already on qemu.org at:
http://wiki.qemu.org/docs-internal/
All it takes to add to this is to submit a patch converting a file to use
gtk-doc syntax and then move the header into include/
For more information on gtk-doc, see:
http://developer.gnome.org/gtk-doc-manual/unstable/
For v2, I'm relying on a fork of gtk-doc that removes the underscore
requirements. I really hate to do this but I like it better than not having
documentation. I'm poking in the gtk+ community to see if there's an upstream
compromise possible.
Anthony Liguori (4):
memory: make memory API parsable by gtkdoc-scan (v2)
docs: add build infrastructure for gtkdocs (v2)
memory: update documentation to be in gtk-doc format
memory: move header into include/ and add to QEMU docs
Makefile | 6 +-
Makefile.docs | 29 +++
Makefile.hw | 1 +
Makefile.target | 1 +
QEMU-docs.xml | 32 +++
include/memory.h | 566 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
memory.h | 522 -------------------------------------------------
7 files changed, 634 insertions(+), 523 deletions(-)
create mode 100644 Makefile.docs
create mode 100644 QEMU-docs.xml
create mode 100644 include/memory.h
delete mode 100644 memory.h
--
1.7.4.1
- [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2),
Anthony Liguori <=
- [Qemu-devel] [PATCH v2 1/4] memory: make memory API parsable by gtkdoc-scan (v2), Anthony Liguori, 2011/12/14
- [Qemu-devel] [PATCH v2 2/4] docs: add build infrastructure for gtkdocs (v2), Anthony Liguori, 2011/12/14
- [Qemu-devel] [PATCH v2 3/4] memory: update documentation to be in gtk-doc format, Anthony Liguori, 2011/12/14
- [Qemu-devel] [PATCH v2 4/4] memory: move header into include/ and add to QEMU docs, Anthony Liguori, 2011/12/14
- Re: [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2), Marc-André Lureau, 2011/12/14