[libvirt] [PATCH 0/2] Fix build of docs
This series probably would qualify as build breaker but I'm posting it anyways. Without this, docs building in apibuild.py fails. Peter Krempa (2): docs: Add method to print warnings in docBuilder class lib: Revert removing of Summary and Description fields in headers docs/apibuild.py | 5 +++++ include/libvirt/libvirt-qemu.h | 3 +++ include/libvirt/libvirt.h.in | 3 +++ include/libvirt/virterror.h | 3 +++ 4 files changed, 14 insertions(+), 0 deletions(-) -- 1.7.8.6
The method was not existing and did not allow to diagnose problems. --- docs/apibuild.py | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/docs/apibuild.py b/docs/apibuild.py index 05c2c8b..3f0ecd9 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -1961,6 +1961,11 @@ class docBuilder: self.index = {} self.basename = name + def warning(self, msg): + global warnings + warnings = warnings + 1 + print msg + def indexString(self, id, str): if str == None: return -- 1.7.8.6
Those fields are used by the apibuild script to create documentation. This commit partialy reverts a4bcefbcff01c9cdc257127df376929cd80304b1. --- include/libvirt/libvirt-qemu.h | 3 +++ include/libvirt/libvirt.h.in | 3 +++ include/libvirt/virterror.h | 3 +++ 3 files changed, 9 insertions(+), 0 deletions(-) diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index 6f4aedc..a37f897 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -1,5 +1,8 @@ /* -*- c -*- * libvirt-qemu.h: Interfaces specific for QEMU/KVM driver + * Summary: qemu specific interfaces + * Description: Provides the interfaces of the libvirt library to handle + * qemu specific methods * * Copyright (C) 2010, 2012 Red Hat, Inc. * diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index fc7fa85..71e41e8 100644 --- a/include/libvirt/libvirt.h.in +++ b/include/libvirt/libvirt.h.in @@ -1,5 +1,8 @@ /* -*- c -*- * libvirt.h: Core interfaces for the libvirt library + * Summary: core interfaces for the libvirt library + * Description: Provides the interfaces of the libvirt library to handle + * virtualized domains * * Copyright (C) 2005-2006, 2010-2012 Red Hat, Inc. * diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index b3f80ab..02b4c57 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -1,5 +1,8 @@ /* * virterror.h: Error handling interfaces for the libvirt library + * Summary: error handling interfaces for the libvirt library + * Description: Provides the interfaces of the libvirt library to handle + * errors raised while using the library. * * Copyright (C) 2006, 2010-2012 Red Hat, Inc. * -- 1.7.8.6
On Fri, Jul 27, 2012 at 03:23:30PM +0200, Peter Krempa wrote:
This series probably would qualify as build breaker but I'm posting it anyways.
Without this, docs building in apibuild.py fails.
Peter Krempa (2): docs: Add method to print warnings in docBuilder class lib: Revert removing of Summary and Description fields in headers
docs/apibuild.py | 5 +++++ include/libvirt/libvirt-qemu.h | 3 +++ include/libvirt/libvirt.h.in | 3 +++ include/libvirt/virterror.h | 3 +++ 4 files changed, 14 insertions(+), 0 deletions(-)
ACK both Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|
On 07/27/12 15:38, Daniel P. Berrange wrote:
On Fri, Jul 27, 2012 at 03:23:30PM +0200, Peter Krempa wrote:
This series probably would qualify as build breaker but I'm posting it anyways.
Without this, docs building in apibuild.py fails.
Peter Krempa (2): docs: Add method to print warnings in docBuilder class lib: Revert removing of Summary and Description fields in headers
docs/apibuild.py | 5 +++++ include/libvirt/libvirt-qemu.h | 3 +++ include/libvirt/libvirt.h.in | 3 +++ include/libvirt/virterror.h | 3 +++ 4 files changed, 14 insertions(+), 0 deletions(-)
ACK both
Daniel
Pushed; Thanks! Peter
participants (2)
-
Daniel P. Berrange -
Peter Krempa