[libvirt] [PATCH 0/2] Fix generation of API docs
The issue fixed by 2/2 was noticed by Claudio Bley, thanks for reporting that. Jiri Denemark (2): docs: event.c source file was renamed as virevent.c docs: Generate documentation for virTypedParams* APIs docs/Makefile.am | 4 +++- docs/apibuild.py | 18 +++++++++++------- 2 files changed, 14 insertions(+), 8 deletions(-) -- 1.8.1.1
--- docs/Makefile.am | 3 ++- docs/apibuild.py | 14 +++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index c95497f..1b7752d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -251,7 +251,8 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \ $(srcdir)/../src/libvirt.c \ $(srcdir)/../src/libvirt-lxc.c \ $(srcdir)/../src/libvirt-qemu.c \ - $(srcdir)/../src/util/virerror.c + $(srcdir)/../src/util/virerror.c \ + $(srcdir)/../src/util/virevent.c $(AM_V_GEN)srcdir=$(srcdir) $(PYTHON) $(APIBUILD) touch $@ diff --git a/docs/apibuild.py b/docs/apibuild.py index e24e42d..d5143e0 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -25,7 +25,7 @@ included_files = { "virterror.h": "header with error specific API definitions", "libvirt.c": "Main interfaces for the libvirt library", "virterror.c": "implements error handling and reporting code for libvirt", - "event.c": "event loop for monitoring file handles", + "virevent.c": "event loop for monitoring file handles", } qemu_included_files = { @@ -63,12 +63,12 @@ ignored_functions = { "virDomainMigratePrepareTunnel3": "private function for tunnelled migration", "virDrvSupportsFeature": "private function for remote access", "DllMain": "specific function for Win32", - "virEventAddHandle": "internal function in event.c", - "virEventUpdateHandle": "internal function in event.c", - "virEventRemoveHandle": "internal function in event.c", - "virEventAddTimeout": "internal function in event.c", - "virEventUpdateTimeout": "internal function in event.c", - "virEventRemoveTimeout": "internal function in event.c", + "virEventAddHandle": "internal function in virevent.c", + "virEventUpdateHandle": "internal function in virevent.c", + "virEventRemoveHandle": "internal function in virevent.c", + "virEventAddTimeout": "internal function in virevent.c", + "virEventUpdateTimeout": "internal function in virevent.c", + "virEventRemoveTimeout": "internal function in virevent.c", } ignored_macros = { -- 1.8.1.1
--- docs/Makefile.am | 3 ++- docs/apibuild.py | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index 1b7752d..7583772 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -252,7 +252,8 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \ $(srcdir)/../src/libvirt-lxc.c \ $(srcdir)/../src/libvirt-qemu.c \ $(srcdir)/../src/util/virerror.c \ - $(srcdir)/../src/util/virevent.c + $(srcdir)/../src/util/virevent.c \ + $(srcdir)/../src/util/virtypedparam.c $(AM_V_GEN)srcdir=$(srcdir) $(PYTHON) $(APIBUILD) touch $@ diff --git a/docs/apibuild.py b/docs/apibuild.py index d5143e0..9a29c42 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -26,6 +26,7 @@ included_files = { "libvirt.c": "Main interfaces for the libvirt library", "virterror.c": "implements error handling and reporting code for libvirt", "virevent.c": "event loop for monitoring file handles", + "virtypedparam.c": "virTypedParameters APIs", } qemu_included_files = { @@ -69,6 +70,9 @@ ignored_functions = { "virEventAddTimeout": "internal function in virevent.c", "virEventUpdateTimeout": "internal function in virevent.c", "virEventRemoveTimeout": "internal function in virevent.c", + "virTypedParameterArrayValidate": "internal function in virtypedparam.c", + "virTypedParameterAssign": "internal function in virtypedparam.c", + "virTypedParameterAssignFromStr": "internal function in virtypedparam.c", } ignored_macros = { -- 1.8.1.1
On 21.01.2013 18:44, Jiri Denemark wrote:
The issue fixed by 2/2 was noticed by Claudio Bley, thanks for reporting that.
Jiri Denemark (2): docs: event.c source file was renamed as virevent.c docs: Generate documentation for virTypedParams* APIs
docs/Makefile.am | 4 +++- docs/apibuild.py | 18 +++++++++++------- 2 files changed, 14 insertions(+), 8 deletions(-)
ACK series. Michal
On Mon, Jan 21, 2013 at 18:46:49 +0100, Michal Privoznik wrote:
On 21.01.2013 18:44, Jiri Denemark wrote:
The issue fixed by 2/2 was noticed by Claudio Bley, thanks for reporting that.
Jiri Denemark (2): docs: event.c source file was renamed as virevent.c docs: Generate documentation for virTypedParams* APIs
docs/Makefile.am | 4 +++- docs/apibuild.py | 18 +++++++++++------- 2 files changed, 14 insertions(+), 8 deletions(-)
ACK series.
Thanks, pushed. Jirka
participants (2)
-
Jiri Denemark -
Michal Privoznik