[libvirt] [PATCH] Fixup manpage names and copyright dates
The copyright dates in the manpages haven't been updated in awhile. Also, when pod2man converts a pod file into a manpage, it will only remove the extension from the filename if it is ".pod". Some of the libvirt pod files are named *.pod.in, and that filename is placed unchanged into the manpage. This patch uses pod2man's --name option to fix that. Believe it or not, there's even a BZ for this: https://bugzilla.redhat.com/show_bug.cgi?id=819364 --- daemon/Makefile.am | 2 +- daemon/libvirtd.pod.in | 2 +- tools/Makefile.am | 8 ++++---- tools/virt-pki-validate.in | 2 +- tools/virt-xml-validate.in | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/daemon/Makefile.am b/daemon/Makefile.am index 74250f6..4c72b7b 100644 --- a/daemon/Makefile.am +++ b/daemon/Makefile.am @@ -376,7 +376,7 @@ POD2MAN = pod2man -c "Virtualization Support" \ -r "$(PACKAGE)-$(VERSION)" -s 8 $(srcdir)/libvirtd.8.in: libvirtd.pod.in - $(AM_V_GEN)$(POD2MAN) $< $@ + $(AM_V_GEN)$(POD2MAN) --name LIBVIRTD $< $@ # This is needed for clients too, so can't wrap in # the WITH_LIBVIRTD conditional diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in index ea6c37d..3ada67c 100644 --- a/daemon/libvirtd.pod.in +++ b/daemon/libvirtd.pod.in @@ -150,7 +150,7 @@ Please refer to the AUTHORS file distributed with libvirt. =head1 COPYRIGHT -Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed in the +Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the libvirt AUTHORS file. =head1 LICENSE diff --git a/tools/Makefile.am b/tools/Makefile.am index c82a2fb..723db8e 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -52,17 +52,17 @@ virt-xml-validate: virt-xml-validate.in Makefile || (rm $@ && exit 1) && chmod +x $@ virt-xml-validate.1: virt-xml-validate.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-XML-VALIDATE $< $(srcdir)/$@ virt-pki-validate: virt-pki-validate.in Makefile $(AM_V_GEN)sed -e 's,[@]SYSCONFDIR@,$(sysconfdir),' < $< > $@ \ || (rm $@ && exit 1) && chmod +x $@ virt-pki-validate.1: virt-pki-validate.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-PKI-VALIDATE $< $(srcdir)/$@ virt-host-validate.1: virt-host-validate.c - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-HOST-VALIDATE $< $(srcdir)/$@ virt-sanlock-cleanup: virt-sanlock-cleanup.in Makefile $(AM_V_GEN)sed -e 's,[@]SYSCONFDIR@,$(sysconfdir),' \ @@ -70,7 +70,7 @@ virt-sanlock-cleanup: virt-sanlock-cleanup.in Makefile || (rm $@ && exit 1) && chmod +x $@ virt-sanlock-cleanup.8: virt-sanlock-cleanup.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-SANLOCK-CLEANUP $< $(srcdir)/$@ virt_host_validate_SOURCES = \ virt-host-validate.c \ diff --git a/tools/virt-pki-validate.in b/tools/virt-pki-validate.in index 4164758..866a235 100755 --- a/tools/virt-pki-validate.in +++ b/tools/virt-pki-validate.in @@ -310,7 +310,7 @@ Alternatively report bugs to your software distributor / vendor. =head1 COPYRIGHT -Copyright (C) 2006-2010 by Red Hat, Inc. +Copyright (C) 2006-2012 by Red Hat, Inc. =head1 LICENSE diff --git a/tools/virt-xml-validate.in b/tools/virt-xml-validate.in index 1959261..9ba3a0a 100644 --- a/tools/virt-xml-validate.in +++ b/tools/virt-xml-validate.in @@ -134,7 +134,7 @@ Alternatively report bugs to your software distributor / vendor. =head1 COPYRIGHT -Copyright (C) 2009-2010 by Red Hat, Inc. +Copyright (C) 2009-2012 by Red Hat, Inc. Copyright (C) 2009 by Daniel P. Berrange =head1 LICENSE -- 1.7.11.2
On 07/25/2012 08:07 AM, Laine Stump wrote:
The copyright dates in the manpages haven't been updated in awhile.
It would be nice to automate this; if we could have a placeholder in pod.in that gets automatically set when creating the .pod. But I'm not sure how easy that would be to set up.
Also, when pod2man converts a pod file into a manpage, it will only remove the extension from the filename if it is ".pod". Some of the libvirt pod files are named *.pod.in, and that filename is placed unchanged into the manpage. This patch uses pod2man's --name option to fix that.
Believe it or not, there's even a BZ for this:
https://bugzilla.redhat.com/show_bug.cgi?id=819364 --- daemon/Makefile.am | 2 +- daemon/libvirtd.pod.in | 2 +- tools/Makefile.am | 8 ++++---- tools/virt-pki-validate.in | 2 +- tools/virt-xml-validate.in | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-)
At any rate, what you have is a strict improvement, even if we don't automate the updating of copyright years. ACK. -- Eric Blake eblake@redhat.com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
On 07/25/2012 10:23 AM, Eric Blake wrote:
The copyright dates in the manpages haven't been updated in awhile. It would be nice to automate this; if we could have a placeholder in
On 07/25/2012 08:07 AM, Laine Stump wrote: pod.in that gets automatically set when creating the .pod. But I'm not sure how easy that would be to set up.
But do we really want to update the copyright anytime the manpage is generated? Shouldn't it only be updated if the code associated with the binary is changed? Obviously that's going to always be true for libvirtd, but possibly not for the other utility commands (which are mostly a .pod and the source code in a single file.)
On 07/25/2012 10:44 AM, Laine Stump wrote:
On 07/25/2012 10:23 AM, Eric Blake wrote:
The copyright dates in the manpages haven't been updated in awhile. It would be nice to automate this; if we could have a placeholder in
On 07/25/2012 08:07 AM, Laine Stump wrote: pod.in that gets automatically set when creating the .pod. But I'm not sure how easy that would be to set up.
But do we really want to update the copyright anytime the manpage is generated? Shouldn't it only be updated if the code associated with the binary is changed? Obviously that's going to always be true for libvirtd, but possibly not for the other utility commands (which are mostly a .pod and the source code in a single file.)
The FSF has taken the stance[1] that for any project maintained in a public VCS, the first change in a year to any file in that project is reason enough to mark all other files in that project of having a copyright of that year. Since libvirt is not owned by the FSF, that does not have a direct bearing on us, but it is certainly food for thought - I much prefer the ability to globally bump copyright on all files on Jan 1 instead of trying to maintain it on a per-file per-edit basis. I guess a counterpoint is that since libvirt does NOT require copyright assignment to a central holding authority, we have files that are copyright by multiple authors, and can't just blindly bump the year for all holders at once. [1] https://www.gnu.org/prep/maintain/maintain.html#Copyright-Notices -- Eric Blake eblake@redhat.com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
participants (2)
-
Eric Blake -
Laine Stump