[libvirt] [PATCH] docs: Make virConnectClose comply to apibuild.py expectations

[Daniel P. Berrange]

On Thu, Jun 23, 2011 at 12:28:47PM +0200, Matthias Bolte wrote:
> 2011/6/23 Eric Blake <eblake at redhat.com>:
> > On 06/22/2011 04:39 PM, Matthias Bolte wrote:
> >> apibuild.py expects a sentence that starts with "Returns"
> >> describing the return value of a function.
> >> ---
> >>  src/libvirt.c |    2 +-
> >>  1 files changed, 1 insertions(+), 1 deletions(-)
> >>
> >> diff --git a/src/libvirt.c b/src/libvirt.c
> >> index 63fe7ff..69e0ea8 100644
> >> --- a/src/libvirt.c
> >> +++ b/src/libvirt.c
> >> @@ -1303,7 +1303,7 @@ error:
> >>   * matching virConnectClose, and all other references will be released
> >>   * after the corresponding operation completes.
> >>   *
> >> - * The return value is the number of remaining references on success
> >> + * Returns the number of remaining references on success
> >
> > ACK, and sorry for missing that (I blame apybuild.py for not making it a
> > fatal problem when it can't find the info it wants).
> 
> Thanks, pushed. I'll post a patch that applies "-Werror" to
> apibuild.py and makes warnings fatal as we wan't to have it warning
> free anyway.

I've actually got code to already do that I have not yet posted
for review. I'll send that so you don't need to duplicate the
effort. 


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 :|