On Fri, Jan 3, 2014 at 9:42 AM, Jose A. Lopes <[email protected]> wrote:
> Add manpage for the KVM daemon.
>
> Signed-off-by: Jose A. Lopes <[email protected]>
> ---
>  Makefile.am         |  1 +
>  man/ganeti-kvmd.rst | 31 +++++++++++++++++++++++++++++++
>  2 files changed, 32 insertions(+)
>  create mode 100644 man/ganeti-kvmd.rst
>
> diff --git a/Makefile.am b/Makefile.am
> index b4df41f..fa11d6b 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -1179,6 +1179,7 @@ man_MANS = \
>         man/ganeti-confd.8 \
>         man/ganeti-luxid.8 \
>         man/ganeti-listrunner.8 \
> +       man/ganeti-kvmd.8 \
>         man/ganeti-masterd.8 \
>         man/ganeti-mond.8 \
>         man/ganeti-noded.8 \
> diff --git a/man/ganeti-kvmd.rst b/man/ganeti-kvmd.rst
> new file mode 100644
> index 0000000..163bf72
> --- /dev/null
> +++ b/man/ganeti-kvmd.rst
> @@ -0,0 +1,31 @@
> +ganeti-kvmd(8) Ganeti | Version @GANETI_VERSION@
> +================================================
> +
> +Name
> +----
> +
> +ganeti-kvmd - Ganeti KVM daemon
> +
> +Synopsis
> +--------
> +
> +**ganeti-kvmd**
> +
> +DESCRIPTION
> +-----------
> +
> +The KVM daemon is responsible for determining whether a given KVM
> +instance was shutdown by an administrator or a user.  For more
> +information read the design document on the KVM daemon.

Please, put here at least a short summary of what the daemon does and
remove the reference to the design document: manpages are for users,
and many of them are downloading the pre-made packages, which don't
include design documents.
So, in general, we try to avoid referencing them from the man pages.


> +
> +FILES
> +-----
> +
> +The KVM daemon monitors Qmp sockets of KVM instances, which are created
> +in the KVM control directory, located under
> +``@LOCALSTATEDIR@/run/ganeti/kvm-hypervisor/ctrl/``.  The KVM daemon
> +also creates shutdown files in this directory.  Finally, the KVM
> +daemon's log file is located under
> +``@LOCALSTATEDIR@/log/ganeti/ganeti-kvmd.log``.  Removal of the KVM
> +control directory, the shutdown files, or the log file, will lead to no
> +errors on the KVM daemon.
> --
> 1.8.5.1
>

Thanks,
Michele

-- 
Google Germany GmbH
Dienerstr. 12
80331 München

Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg
Geschäftsführer: Graham Law, Christine Elizabeth Flores

Reply via email to