[libvirt] [PATCH] libvirtd: add man page for libvirtd

[Chris Lalancette]

On 07/09/10 - 05:20:27AM, Justin Clift wrote:
> From: Justin Clift <justin at salasaga.org>
> 
> Gracious thanks to Chris Lalancette for helping knock the description
> section into shape.
> 
> This addresses BZ #595350
> 
>   https://bugzilla.redhat.com/show_bug.cgi?id=595350

It looks pretty good to me; a few comments inline.

> diff --git a/daemon/Makefile.am b/daemon/Makefile.am
> index df34ef1..332e895 100644
> --- a/daemon/Makefile.am
> +++ b/daemon/Makefile.am
...
> @@ -50,6 +53,41 @@ augeas_DATA = libvirtd.aug
>  augeastestsdir = $(datadir)/augeas/lenses/tests
>  augeastests_DATA = test_libvirtd.aug
>  
> +POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" -s 8
> +
> +if WITH_REMOTE
> +libvirtd.pod: libvirtd.pod.in
> +	sed \
> +	    -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
> +	    -e 's![@]localstatedir[@]!$(localstatedir)!g' \
> +	    -e 's![@]tls_line1[@]!=item F<$(sysconfdir)/pki/CA/cacert.pem>!g' \
> +	    -e 's![@]tls_line2[@]!The TLS B<Certificate Authority> certificate libvirtd will use.!g' \
> +	    -e 's![@]tls_line3[@]!=item F<$(sysconfdir)/pki/libvirt/servercert.pem>!g' \
> +	    -e 's![@]tls_line4[@]!The TLS B<Server> certificate libvirtd will use.!g' \
> +	    -e 's![@]tls_line5[@]!=item F<$(sysconfdir)/pki/libvirt/private/serverkey.pem>!g' \
> +	    -e 's![@]tls_line6[@]!The TLS B<Server> private key libvirtd will use.!g' \
> +	    -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
> +	    < $< > $@-t
> +	mv $@-t $@
> +else
> +libvirtd.pod: libvirtd.pod.in
> +	sed \
> +	    -e 's![@]sysconfdir[@]!$(sysconfdir)!g' \
> +	    -e 's![@]localstatedir[@]!$(localstatedir)!g' \
> +	    -e 's![@]tls_line1[@]!!g' \
> +	    -e 's![@]tls_line2[@]!!g' \
> +	    -e 's![@]tls_line3[@]!!g' \
> +	    -e 's![@]tls_line4[@]!!g' \
> +	    -e 's![@]tls_line5[@]!!g' \
> +	    -e 's![@]tls_line6[@]!!g' \
> +	    -e 's![@]remote_pid_file[@]!$(REMOTE_PID_FILE)!g' \
> +	    < $< > $@-t
> +	mv $@-t $@
> +endif

While this is fun and tricky, I'm not 100% convinced that we should do this.
I would think we would want the same manpage regardless of what options are
compiled in.  While it could be a bit confusing in that options are listed
in the manpage that aren't actually available in this build, it's at least
consistent.  Though I could be convinced otherwise.

<snip>

> diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in
> new file mode 100644
> index 0000000..33437c9
> --- /dev/null
> +++ b/daemon/libvirtd.pod.in
> @@ -0,0 +1,168 @@
...
> +=head1 AUTHORS
> +
> + Andrew Puch <apuch @ redhat.com>
> + Daniel Veillard <veillard @ redhat.com>

This isn't really right, despite what the source comments might say :).  From
a "git annotate daemon/libvirtd.c", I see at least:

Daniel P. Berrange
Jim Meyering
Mark McLoughlin
Richard W.M. Jones
Eric Blake
Stefan Berger
Matthias Bolte
John Levon
Daniel Veillard
Chris Lalancette
Jiri Denemark
Cole Robinson
Atsushi SAKAI
Amy Griffis
Guido Günther

> +
> +=head1 COPYRIGHT
> +
> +Copyright (C) 2010 Red Hat, Inc.
> +

I'm definitely not a copyright guy, so I'm not sure.  I know we have headers
that say this, but as far as I know we don't have copyright assignment for
libvirt.  Given the list of authors above, I'm not sure if this is correct or
not.

--
Chris Lalancette