[libvirt] [PATCH] build-sys: distribute the man pages in the tarball

Eric Blake eblake at redhat.com
Wed Feb 16 22:28:49 UTC 2011


On 08/09/2010 05:12 PM, Eric Blake wrote:
> On 08/09/2010 04:55 PM, Diego Elio Pettenò wrote:
>> This slightly reduces the requirements for building libvirt.
>>
>> The man pages are deleted with make maintainer-clean.

Reviving an old thread...

>> ---
>>  daemon/Makefile.am |    5 +++--
>>  tools/Makefile.am  |    5 +++--
>>  2 files changed, 6 insertions(+), 4 deletions(-)
> 
> This fails 'make distcheck':
> 
> ERROR: files left in build directory after distclean:
> ./tools/virt-xml-validate.1
> ./tools/virt-pki-validate.1
> ./daemon/libvirtd.8
> make[1]: *** [distcleancheck] Error 1
> 
> I didn't have time to look into it further today, but it needs a bit
> more tweaking before it is ready.  Interestingly, virsh.1 didn't show up
> on that list - what is different about that compared to the other three?

I found out why.  virsh.1 is generated from virsh.pod (a static
document); while libvirtd.8 is generated from libvirtd.pod (a dynamic
document which reflects ./configure options) which in turn is generated
from libvirtd.pod.in (a static document).  It's a no-no to ever
distribute a file that depends on configure results.

It seems to me that your request is really about removing an end-user
dependence on pod2man.  It also seems that this is quite doable, but in
a different manner.  Rather than shipping just libvirtd.pod.in and
generating libvirtd.pod and libvirtd.8 on the fly (which requires first
sed then pod2man), or your proposal of shipping libvirtd.pod.in and
libvirtd.8 (but missing out on libvirtd.pod, and breaking distcheck), we
instead ship libvirtd.pod.in and libvirtd.1.in (requiring pod2man), but
generate libvirtd.8 on the fly (using just sed).

I'm working up a rewrite of your patch that does this; although, seeing
as how it touches the build machinery, it may be deemed too risky for 0.8.8.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

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


More information about the libvir-list mailing list