Re: [libvirt] [PATCH v2 1/7] docs: abort when missing return or argument documention

[1 <text/plain; UTF-8 (quoted-printable)>] On 01/29/2013 08:05 AM, Claudio Bley wrote: > When a function has no associated information to one of its > arguments or its return type we report it and stop with an error. s/documention/documentation/ in the subject.

> Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; > --- > docs/apibuild.py | 15 +++++++++++++-- > 1 file changed, 13 insertions(+), 2 deletions(-) In isolation, this fails 'make check' and 'make syntax-check'; please fix your series to have this patch apply cleanly, and/or call out the prerequisite patches that must be reviewed and applied first.

> @@ -2462,6 +2469,10 @@ class docBuilder: > output.write("</api>\n") > output.close() > > + if self.errors > 0: > + print >>sys.stderr, "apibuild.py: %d error(s) encountered during generation. Stop." % self.errors "Stop." doesn't add anything to the error message; it's already obvious from 'make' exiting that things stopped abnormally. Here's what I suggest squashing in to fix the 'make syntax-check' side of things:

Then we do have our hands full with some missing docs: GEN apibuild.py.stamp Error: Missing documentation for return of function `virConnCopyLastError' Error: Missing documentation for arg `virConnCopyLastError' of function `conn' Error: Missing documentation for arg `virConnCopyLastError' of function `to' Error: Missing documentation for return of function `virConnGetLastError' Error: Missing documentation for arg `virConnGetLastError' of function `conn' Error: Missing documentation for arg `virConnResetLastError' of function `conn' Error: Missing documentation for arg `virConnSetErrorFunc' of function `conn' Error: Missing documentation for arg `virConnSetErrorFunc' of function `userData' Error: Missing documentation for arg `virConnSetErrorFunc' of function `handler' Error: Missing documentation for arg `virConnectCloseFunc' of function `conn' Error: Missing documentation for arg `virConnectCloseFunc' of function `reason' Error: Missing documentation for arg `virConnectCloseFunc' of function `opaque' Error: Missing documentation for arg `virConnectDomainEventBlockJobCallback' of function `disk' Error: Missing documentation for arg `virConnectDomainEventBlockJobCallback' of function `opaque' Error: Missing documentation for return of function `virConnectDomainEventCallback' Error: Missing documentation for return of function `virCopyLastError' Error: Missing documentation for arg `virCopyLastError' of function `to' Error: Missing documentation for arg `virDefaultErrorFunc' of function `err' Error: Missing documentation for return of function `virEventAddHandle' Error: Missing documentation for arg `virEventAddHandle' of function `fd' Error: Missing documentation for arg `virEventAddHandle' of function `events' Error: Missing documentation for arg `virEventAddHandle' of function `cb' Error: Missing documentation for arg `virEventAddHandle' of function `opaque' Error: Missing documentation for arg `virEventAddHandle' of function `ff' Error: Missing documentation for return of function `virEventAddTimeout' Error: Missing documentation for arg `virEventAddTimeout' of function `timeout' Error: Missing documentation for arg `virEventAddTimeout' of function `cb' Error: Missing documentation for arg `virEventAddTimeout' of function `opaque' Error: Missing documentation for arg `virEventAddTimeout' of function `ff' Error: Missing documentation for return of function `virEventRemoveHandle' Error: Missing documentation for arg `virEventRemoveHandle' of function `watch' Error: Missing documentation for return of function `virEventRemoveHandleFunc' Error: Missing documentation for return of function `virEventRemoveTimeout' Error: Missing documentation for arg `virEventRemoveTimeout' of function `timer' Error: Missing documentation for arg `virEventUpdateHandle' of function `watch' Error: Missing documentation for arg `virEventUpdateHandle' of function `events' Error: Missing documentation for arg `virEventUpdateTimeout' of function `timer' Error: Missing documentation for arg `virEventUpdateTimeout' of function `timeout' Error: Missing documentation for arg `virFreeError' of function `err' Error: Missing documentation for return of function `virGetLastError' Error: Missing documentation for arg `virResetError' of function `err' Error: Missing documentation for return of function `virSaveLastError' Error: Missing documentation for arg `virSetErrorFunc' of function `userData' Error: Missing documentation for arg `virSetErrorFunc' of function `handler' apibuild.py: 44 error(s) encountered during generation