Re: [libvirt PATCH v2 1/1] virt-ssh-helper: Add manual page
On Fri, Jan 07, 2022 at 04:30:33PM +0100, Michal Prívozník wrote:
On 12/13/21 14:44, Andrea Bolognani wrote:
> We don't usually provide manual pages for internal tools,
> but in the case of virt-ssh-helper the command is installed
> inside the default $PATH and so it's likely that the user
> will stumble upon it by using the shell's completion feature
> when invoking another virt-* command, which makes it a good
> idea to provide at least a minimal manual page.
>
> Signed-off-by: Andrea Bolognani <abologna(a)redhat.com>
> ---
> docs/manpages/meson.build | 1 +
> docs/manpages/virt-ssh-helper.rst | 95 +++++++++++++++++++++++++++++++
> libvirt.spec.in | 1 +
> 3 files changed, 97 insertions(+)
> create mode 100644 docs/manpages/virt-ssh-helper.rst
Reviewed-by: Michal Privoznik <mprivozn(a)redhat.com>
I just realized that there is a small bug in the patch:
virt-ssh-helper is only built and installed when the daemon is, and
obviously the same should happen to its manual page. I have squashed
in the diff below before pushing.
Thanks for the review! :)
diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build
index bf6fc730e0..6763d19af8 100644
--- a/docs/manpages/meson.build
+++ b/docs/manpages/meson.build
@@ -19,7 +19,7 @@ docs_man_files = [
{ 'name': 'virt-pki-query-dn', 'section': '1',
'install': true },
{ 'name': 'virt-pki-validate', 'section': '1',
'install': true },
{ 'name': 'virt-qemu-run', 'section': '1',
'install':
conf.has('WITH_QEMU') },
- { 'name': 'virt-ssh-helper', 'section': '1',
'install': true },
+ { 'name': 'virt-ssh-helper', 'section': '1',
'install':
conf.has('WITH_LIBVIRTD') },
{ 'name': 'virt-xml-validate', 'section': '1',
'install': true },
{ 'name': 'libvirtd', 'section': '8',
'install': conf.has('WITH_LIBVIRTD') },
--
Andrea Bolognani / Red Hat / Virtualization