[pve-devel] [PATCH qemu-server v3 1/3] add qmeventd

[Wolfgang Bumiller]

On Wed, Oct 31, 2018 at 09:55:15AM +0100, Thomas Lamprecht wrote:
> Am 10/31/2018 um 09:43 AM schrieb Dominik Csapak:
> > On 10/31/18 9:04 AM, Thomas Lamprecht wrote:
> >> Am 10/30/2018 um 04:06 PM schrieb Dominik Csapak:
> >>> this adds a program that can listen to qemu qmp events on a given socket
> >>> and if a shutdown event followed by a disconnected socket occurs,
> >>> executes qm cleanup with arguments that indicate if the
> >>> vm was closed gracefully and whether the guest initiated it
> >>>
> >>> this is useful if we want to cleanup after the qemu process exited,
> >>> e.g. tap devices, vgpus, etc.
> >>>
> >>> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
> >>> ---
> >>>   Makefile         |  21 ++-
> >>>   debian/control   |   1 +
> >>>   debian/rules     |   2 +-
> >>>   qmeventd.c       | 386 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >>>   qmeventd.h       |  45 +++++++
> >>>   qmeventd.rst     |  38 ++++++
> >>
> >> Only reading the extension of the file above I thought you did it with Rust ;-)
> >>
> >> So why restructured text and not or proven asciidoc?

s/or proven//

> >> (Not really oposed, but you nowhere mention the docs/man page at all, AFAICT,
> >> and your reasoning for RsT while everything else is asciidoc would be good to
> >> have). pve-doc-generator has infrastructure for .adoc to man...
> > 
> > i found no easy way to generate a manpage from a simple .adoc, i would have to send patches for pve-docs also, which seemed unnecessary for
> > such a 'simple' binary (as in has not many flags/options, and will
> > probably not used by many by hand)
> > 
> > also wolfgang proposed this off-list ;)
> 
> Mention this would always be nice ;) Just throwing in another docs
> format without explanation reasoning is a bit confusing.
> 
> qemu-sever already uses pve-docs, and if it won't change often or at
> all then we have not much maintenance burden having it there...
> Just as a side note, it's Wolfgang's call, I'm mostly just
> complaining for lack of any reasoning... ;)
> 

My reasons were these:

1)
> It's fine for me to do it afterwards.
> Talk with Fabian, though, he's in the process of cleaning up and
> wants to move away from top level hackery :-)
                                    ^~~~~~~


2) Drafting in a sane language which can easily translate to all our
actually-used languages (adoc, mediawiki, ...) and produces manpages for
quick review...
   $ rst2man qmeventd.rst qmeventd.1
   or
   $ pandoc -s -f rst -t man -o qmeventd.1 qmeventd.rst

is nice, especially if once you have a final version and know where/how
to properly integrate it into our by-then-hopefully-cleaned-up build
process you can just:

3) $ pandoc -s \
    -f rst \
    -t asciidoc \
    -o qmeventd.adoc qmeventd.rst

and continue with the .adoc from then on...
Note that the other way round does not work, as pandoc cannot *read*
asciidoc, only write it...