[libvirt] [PATCH 00/13] build: Fix and improve man pages handling

John Ferlan jferlan at redhat.com
Fri Apr 22 19:22:51 UTC 2016



On 04/14/2016 08:33 AM, Andrea Bolognani wrote:
> There are a bunch of issues in the way we handle man pages;
> most importantly, installed man pages (like libvirtd.8) end
> up having stuff like
> 
>   SYSCONFDIR/libvirtd.conf
> 
> in the FILES section.
> 
> This series makes it so all man pages are generated through the
> same steps:
> 
>   1. process $command.pod (shipped) with pod2man(1) to
>      convert pod markup to groff markup and obtain
>      $command.$section.in (shipped)
> 
>   2. process $command.$section.in with sed(1) to insert
>      host-specific information such as @sysconfdir@
>      and obtain $command.$section (not shipped)
> 
> As a follow-up improvement, it would be great if we could
> abstract those two steps into macros to reduce code duplication
> even further. Please provide hints on the best way to
> achieve that :)
> 
> A number of other minor issues are fixed along the way.
> 
> Cheers.
> 
> 
> Andrea Bolognani (13):
>   build: Ship virt-admin.pod
>   build: Extract pod from source files
>   build: Build man pages in $(builddir)
>   build: Perform post-processing on all man pages
>   build: Standardize on .pod -> .x.in -> .x
>   build: Never ship man pages
>   build: Group files
>   build: Ensure intermediate files are cleaned up properly
>   build: Replace variables in man pages
>   build: Always ship virt-login-shell.conf
>   man: Fix NAME section
>   man: Fix SYNOPSIS section
>   man: Fix links
> 
>  daemon/Makefile.am                              |  43 +++++----
>  daemon/{libvirtd.pod.in => libvirtd.pod}        |   4 +-
>  src/Makefile.am                                 |  69 ++++++++------
>  src/locking/{virtlockd.pod.in => virtlockd.pod} |   4 +-
>  src/logging/{virtlogd.pod.in => virtlogd.pod}   |   4 +-
>  tools/Makefile.am                               | 114 +++++++++++++++---------
>  tools/virsh.pod                                 |   6 +-
>  tools/virt-admin.pod                            |   6 +-
>  tools/virt-host-validate.c                      |  74 ---------------
>  tools/virt-host-validate.pod                    |  68 ++++++++++++++
>  tools/virt-login-shell.pod                      |   3 +-
>  tools/virt-pki-validate.in                      |  64 -------------
>  tools/virt-pki-validate.pod                     |  61 +++++++++++++
>  tools/virt-sanlock-cleanup.in                   |  52 -----------
>  tools/virt-sanlock-cleanup.pod                  |  49 ++++++++++
>  tools/virt-xml-validate.in                      | 113 -----------------------
>  tools/virt-xml-validate.pod                     | 111 +++++++++++++++++++++++
>  17 files changed, 440 insertions(+), 405 deletions(-)
>  rename daemon/{libvirtd.pod.in => libvirtd.pod} (97%)
>  rename src/locking/{virtlockd.pod.in => virtlockd.pod} (97%)
>  rename src/logging/{virtlogd.pod.in => virtlogd.pod} (97%)
>  create mode 100644 tools/virt-host-validate.pod
>  create mode 100644 tools/virt-pki-validate.pod
>  create mode 100644 tools/virt-sanlock-cleanup.pod
>  create mode 100644 tools/virt-xml-validate.pod
> 

Changes seem reasonable to me (although not exactly my specialty).
Should I assume you ran make dist or distcheck to ensure everything gets
to the right place?  I'm missing some things so those don't work for me
any more (first error for me was "recipe for target
'libvirt-daemon-arch.png' failed" - I didn't bother to dig).

ACK

John




More information about the libvir-list mailing list