Re: [Qemu-devel] [PATCH] Makefile: Install qmp-events.txt

[Eric Blake]

On 06/25/2014 03:30 AM, Michal Privoznik wrote:
> Since fe069d9d5946 the qmp-events.txt does not exist anymore. This is
> unhappy as users still may want to know what events they can await
> from qemu.

The .json files are a better contract of what is supported, anyways.

> 
> Signed-off-by: Michal Privoznik <address@hidden>
> ---
>  Makefile | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/Makefile b/Makefile
> index 145adb6..b93aa38 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -77,7 +77,7 @@ LIBS+=-lz $(LIBS_TOOLS)
>  HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF)
>  
>  ifdef BUILD_DOCS
> -DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 
> qmp-commands.txt
> +DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 
> qmp-commands.txt qmp-events.txt

Then again, qmp-commands.txt is generated from qmp-commands.hx, which
duplicates information already in qapi-schema.json (and friends, now).
Would it be better to just install the .json files?  Is it time to
finally bite the bullet and figure out how to get rid of duplication by
dropping qmp-commands.hx, and instead listing example usage directly in
the qapi-schema.json file?  I'm not sure if we have a good plan in place
for user-facing documentation, even if the move to events-as-QAPI was
desirable.

>  ifdef CONFIG_VIRTFS
>  DOCS+=fsdev/virtfs-proxy-helper.1
>  endif
> @@ -353,6 +353,7 @@ install-doc: $(DOCS)
>       $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
>       $(INSTALL_DATA) qemu-doc.html  qemu-tech.html "$(DESTDIR)$(qemu_docdir)"
>       $(INSTALL_DATA) qmp-commands.txt "$(DESTDIR)$(qemu_docdir)"
> +     $(INSTALL_DATA) qmp-events.txt "$(DESTDIR)$(qemu_docdir)"
>  ifdef CONFIG_POSIX
>       $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
>       $(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1"
> @@ -455,6 +456,9 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx
>  qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx
>       $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@,"  GEN  
>  $@")
>  
> +qmp-events.txt: $(SRC_PATH)/qapi-event.json
> +     $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -h < $< > $@,"  GEN  
>  $@")
> +
>  qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
>       $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"  GEN  
>  $@")
>  
> 

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

signature.asc
Description: OpenPGP digital signature