From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,HTML_MESSAGE,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 20D97C48BE5 for ; Wed, 16 Jun 2021 15:50:51 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 80E3160FF1 for ; Wed, 16 Jun 2021 15:50:50 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 80E3160FF1 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:50582 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ltXoW-0007d6-VM for qemu-devel@archiver.kernel.org; Wed, 16 Jun 2021 11:50:49 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56834) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ltXmh-0005nY-Lo for qemu-devel@nongnu.org; Wed, 16 Jun 2021 11:48:55 -0400 Received: from mail-io1-xd2d.google.com ([2607:f8b0:4864:20::d2d]:41680) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ltXmf-0006H4-Oj for qemu-devel@nongnu.org; Wed, 16 Jun 2021 11:48:55 -0400 Received: by mail-io1-xd2d.google.com with SMTP id p66so3514600iod.8 for ; Wed, 16 Jun 2021 08:48:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=MKecy4krVgYPtiKN//SwtR6H/Y3bYdimls2q+4h80Yc=; b=m48WDNkYZnC0RZrxXYZjSfNcaejkeXSsyIDjIVoYpJk8ahPlMpMNty0j9/SPvYkCEh 40dhXZE2JsRmMZYQM1d0iwsr5lNfWUMYAa+gsZdPjKSEkzdgyOXrExj5z7BeCvAbGBIa fvC/VRuv+yYA9gUJd/1rEF9bPqLqytz80UKL+Hcha2NmL5YirClcPoRYZ7PDnIYOjuqn qSUxnumd/gilQg84KUnwzZPkqno+b/I/zaeqd0Zi2osMODaHTjau0TnfxV2PpywlMal8 0KXg72gXlVQlJGJ1m6XGXpcEzMNW01O/hJPgKZ6Rlo6hmbdgFGQsVCBgHLPhAlV4Mt5M CWFg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=MKecy4krVgYPtiKN//SwtR6H/Y3bYdimls2q+4h80Yc=; b=QvIRP5fzMhgD4aBpdcVFTPNuAWF/sgpXENfNeJHpbQswf+7HTfwPv99KyKJq1laRmF 697nlyrzJ0esjaGxW1cQucSCUbn14QVyatxEkl6TLGfz1NkQmNMBGa41G7QcDhwAFSEl tX27MhpjuKSoNxjH3hB7kQ3+HRjG8sREJWDrzf4d+PSSyhgLL/Zlu5yA23mC/gyDcBsD TRPXIdGb1dKcKQVHovTN1+JrpxygBGMD5twfJ9QZTX/JuH6DFLMYr7upIKXv/lfaRSlj jd87jaDRxVVXBj2xEHUH3Mhsw9zbpMUmQH6i+Cj9Ps6IaQinIJHQDP8quRxgJ9V+xaHW z3Dg== X-Gm-Message-State: AOAM532abw67UpJJzedLwwJLQmHH3rfSdimRIXkOT7rkt1V3FsLKeTQ8 jbwHNJemoFETKnbF6AteBJd5btcZ+le1K5EQ2Io= X-Google-Smtp-Source: ABdhPJzvw0wF+d9zNcSdDLdujwrb8gKqD4T9mKn2QDEIjqhIyNohcpbHIqZt4kTCmKYSCEjzRQCGmptvh8s2bKJjlwU= X-Received: by 2002:a05:6602:807:: with SMTP id z7mr84803iow.128.1623858531955; Wed, 16 Jun 2021 08:48:51 -0700 (PDT) MIME-Version: 1.0 From: "Niteesh G. S." Date: Wed, 16 Jun 2021 21:18:26 +0530 Message-ID: Subject: RFC: Implementation of QMP documentation retrieval command To: John Snow , armbru@redhat.com, Stefan Hajnoczi , kwolf@redhat.com, ehabkost@redhat.com, wainersm@redhat.com, qemu-devel@nongnu.org, vsementsov@virtuozzo.com Content-Type: multipart/alternative; boundary="000000000000f6791a05c4e406ac" Received-SPF: pass client-ip=2607:f8b0:4864:20::d2d; envelope-from=niteesh.gs@gmail.com; helo=mail-io1-xd2d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" --000000000000f6791a05c4e406ac Content-Type: text/plain; charset="UTF-8" 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. --000000000000f6791a05c4e406ac Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Hel= lo,

<= div class=3D"gmail_default" style=3D"font-size:small">We now have a reasona= bly working prototype that is capable of sending/receiving
commands/responses, syntax hig= hlighting, 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 docu= mentation 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=C2=A0all continue that discussion here and suggest ide= as 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 docume= ntation here
https://gitlab.com/niteesh.gs/qemu/-/commit/796a41fb284= 0b9f3484c6fd5672e6fceb73acaef

Thanks,
Niteesh.
--000000000000f6791a05c4e406ac--