[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH] Add a man page for virtlockd daemon



On 08/08/2013 09:07 AM, Daniel P. Berrange wrote:
> From: "Daniel P. Berrange" <berrange redhat com>
> 
> Create a virtlockd.pod.in file containing the man page
> content for virtlockd.
> 
> Signed-off-by: Daniel P. Berrange <berrange redhat com>
> ---
>  .gitignore                   |   2 +
>  libvirt.spec.in              |   1 +
>  src/Makefile.am              |  24 ++++++-
>  src/locking/virtlockd.pod.in | 158 +++++++++++++++++++++++++++++++++++++++++++
>  4 files changed, 184 insertions(+), 1 deletion(-)
>  create mode 100644 src/locking/virtlockd.pod.in

> 
> +=head1 SYNOPSIS
> +
> +B<virtlockd> [ -dv ] [ -f config_file ] [ -p pid_file ]
> +
> +B<virtlockd> --version

Hmm, you have the opposite problem from virt-login-shell, with --version
but no --help :)

> +
> +=head1 DESCRIPTION
> +
> +The B<virtlockd> program is a server side daemon component of the libvirt
> +virtualization management system that is used to manage locks held against
> +virtual machine resources, such as their disks.
> +
> +This daemon is not used directly by libvirt client applications, rather it
> +is called on their behalf by B<libvirtd>. By maintaining the locks in a
> +standalone daemon, the main libvirtd daemon can be restarted without risk
> +of loosing locks.  The B<virtlockd> daemon has the ability to re-exec()

s/loosing/losing/

> +=item B<-d, --daemon>
> +
> +Run as a daemon & write PID file.

s/&/and/ (man pages tend to use stodgy full-grammared sentences instead
of abbreviations...)


> +=head1 BUGS
> +
> +Please report all bugs you discover.  This should be done via either:

Hmm - wondering if we should put this boilerplate into a common sub-file
included by all the other .pod man page templates, so that we have some
consistency (and so that we only have to update one boilerplate instead
of copying and pasting across files if we change our mind on what the
boilerplate should say).

ACK with grammar/spelling fixes listed above; the longer comments are
food for thought but don't hold up this patch.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]