[libvirt] [PATCH] build: check for pod errors

Eric Blake eblake at redhat.com
Fri Oct 26 19:07:41 UTC 2012


On 10/26/2012 11:36 AM, Martin Kletzander wrote:
> On 10/26/2012 06:06 PM, Eric Blake wrote:
>> Patch 61299a1 fixed a long-standing pod error in the man page.
>> But we should be preventing these up front.
>>
>> * tools/Makefile.am (virt-xml-validate.1, virt-pki-validate.1)
>> (virt-host-validate.1, virt-sanlock-cleanup.8, virsh.1): Reject
>> pod conversion errors.
>> * daemon/Makefile.am ($(srcdir)/libvirtd.8.in): Likewise.
>> ---
>>
>> I tested that with this patch but not Jirka's cleanup, 'make' failed;
>> with both patches, make succeeds and there are no buggy man pages.

>>  $(srcdir)/libvirtd.8.in: libvirtd.pod.in
>> -	$(AM_V_GEN)$(POD2MAN) --name LIBVIRTD $< $@
>> +	$(AM_V_GEN)$(POD2MAN) --name LIBVIRTD $< $@ \
>> +	    && if grep 'POD ERROR' $@ ; then exit 1; fi
>>
> 
> At first I've mistaken $< for $@, but your version is correct.  But if I
> may have a suggestion, I'd do 'then rm $@; exit', so it fails also when
> you re-run make again.

Good call.

>>  virt-xml-validate.1: virt-xml-validate.in
>> -	$(AM_V_GEN)$(POD2MAN) --name VIRT-XML-VALIDATE $< $(srcdir)/$@
>> +	$(AM_V_GEN)$(POD2MAN) --name VIRT-XML-VALIDATE $< $(srcdir)/$@ \
>> +	    && if grep 'POD ERROR' $@ ; then exit 1; fi
>>
> 
> s_$@_$(srcdir)/$@_

Bah - copy-and-paste bit me, and I only tested the bug in virsh.pod so I
didn't spot it.  Then again, that's why we do reviews :)

> 
> ACK with those fixes (both with or without the "rm" added).

Fixing to add the rm, and then I'll push.  Thanks again!

-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 617 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20121026/5234d11b/attachment-0001.sig>


More information about the libvir-list mailing list