RFC: Implementation of QMP documentation retrieval command

From: "Niteesh G. S." <niteesh.gs@gmail.com>
To: John Snow <jsnow@redhat.com>,
	armbru@redhat.com,  Stefan Hajnoczi <stefanha@redhat.com>,
	kwolf@redhat.com, ehabkost@redhat.com,  wainersm@redhat.com,
	qemu-devel@nongnu.org, vsementsov@virtuozzo.com
Subject: RFC: Implementation of QMP documentation retrieval command
Date: Wed, 16 Jun 2021 21:18:26 +0530	[thread overview]
Message-ID: <CAN6ztm8D4VMf7p-trHNHoOA+1kAXXufTTaHpbyNXZ5qO2_uuPg@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 1087 bytes --]

Hello,

We now have a reasonably working prototype that is capable of
sending/receiving
commands/responses, syntax highlighting, and a simple notification system.
The
prototype can be found here
https://gitlab.com/niteesh.gs/qemu/-/tree/aqmp-tui-prototype
Working on this prototype gives us a lot of hints on things to worry about
and other
ideas that were worth implementing. Our next goal is to start working on
the real TUI
based on this prototype.

One requested feature of the TUI was to show documentation for the commands
typed.
To achieve this, a QMP command that lets us query the documentation from
QEMU has
to be implemented and some discussion has already been done on it in a
previous thread.
I request all continue that discussion here and suggest ideas regarding
implementation.
The goal is to come up with something small and simple which can also be
improved upon
after the summer.

I have a simple implementation of the command that returns dummy
documentation here
https://gitlab.com/niteesh.gs/qemu/-/commit/796a41fb2840b9f3484c6fd5672e6fceb73acaef

Thanks,
Niteesh.

[-- Attachment #2: Type: text/html, Size: 2477 bytes --]