From: Eric Blake <eblake@redhat.com>
To: Aleksandar Markovic <aleksandar.m.mail@gmail.com>,
Peter Maydell <peter.maydell@linaro.org>
Cc: "Yoshinori Sato" <ysato@users.sourceforge.jp>,
"Richard Henderson" <richard.henderson@linaro.org>,
"QEMU Developers" <qemu-devel@nongnu.org>,
"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>
Subject: Re: [PATCH v31 20/22] Add rx-softmmu
Date: Mon, 24 Feb 2020 12:31:21 -0600 [thread overview]
Message-ID: <c044121d-d933-f4e7-184b-1b9f171a541d@redhat.com> (raw)
In-Reply-To: <CAL1e-=hGQD2aJQhAXiYDnsTa71xm_yoDzVFjuAfB-=ydxkesDg@mail.gmail.com>
On 2/24/20 11:53 AM, Aleksandar Markovic wrote:
>>>> Missing mention of the new enum member with a 'since 5.0' designation
>>>> in the documentation.
>>>
> Just want to bring to your attention a point that is not clear to me here.
> (forgive me for being an outsider in this area)
No problem - asking questions is how we learn.
>
> Could you please take a look at commit:
>
> bb5ccf225e81d2801c03e63d16c371f0617270e8
> <https://github.com/qemu/qemu/commit/bb5ccf225e81d2801c03e63d16c371f0617270e8#diff-d7db5c644ce52a6080e77ef1e7a3811b>
>
> I am not familiar with QAPI doc generator, but shouldn't "Since: 3.0"
> cause the same problem as "ppcemb: dropped in 3.1"? If not, why?
That was the opposite direction - in that commit, we were removing stale
comments about a member that was no longer present (if the member is not
present, the doc engine doesn't know what to attach the tag to, and we
now have the better qemu-deprecated.texi file for tracking removals).
And even if the removal is not documented, users that depended on it
(which should be few, or we would not have removed it), it becomes
fairly obvious at the attempted point of use that it no longer works.
But when the member is present, but added later than the original
struct, knowing what release the additional members were added is useful
documentation when deciding whether support for the new member is
present on all versions of qemu you care about, or whether your
management code has to consider the case when the member was absent.
Yes, you can get the same information from introspection
programmatically (in fact, when libvirt has to deal with new additions,
that's how it probes whether the addition is there), but having the
consistent documentation reminds someone to think about whether checking
the introspection is necessary.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
next prev parent reply other threads:[~2020-02-24 18:33 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-23 6:50 [PATCH v31 00/22] Add RX archtecture support Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 01/22] MAINTAINERS: Add RX Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 02/22] qemu/bitops.h: Add extract8 and extract16 Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 03/22] hw/registerfields.h: Add 8bit and 16bit register macros Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 04/22] target/rx: TCG translation Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 05/22] target/rx: TCG helper Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 06/22] target/rx: CPU definition Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 07/22] target/rx: RX disassembler Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 08/22] target/rx: Disassemble rx_index_addr into a string Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 09/22] target/rx: Replace operand with prt_ldmi in disassembler Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 10/22] target/rx: Use prt_ldmi for XCHG_mr disassembly Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 11/22] target/rx: Emit all disassembly in one prt() Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 12/22] target/rx: Collect all bytes during disassembly Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 13/22] target/rx: Dump bytes for each insn " Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 14/22] hw/intc: RX62N interrupt controller (ICUa) Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 15/22] hw/timer: RX62N internal timer modules Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 16/22] hw/char: RX62N serial communication interface (SCI) Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 17/22] hw/rx: RX Target hardware definition Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 18/22] hw/rx: Honor -accel qtest Yoshinori Sato
2020-02-23 6:50 ` [PATCH v31 19/22] hw/rx: Restrict the RX62N microcontroller to the RX62N CPU core Yoshinori Sato
2020-02-23 6:51 ` [PATCH v31 20/22] Add rx-softmmu Yoshinori Sato
2020-02-24 15:11 ` Eric Blake
2020-02-24 15:15 ` Philippe Mathieu-Daudé
2020-02-24 15:30 ` Eric Blake
2020-02-24 17:53 ` Aleksandar Markovic
2020-02-24 18:31 ` Eric Blake [this message]
2020-02-23 6:51 ` [PATCH v31 21/22] BootLinuxConsoleTest: Test the RX-Virt machine Yoshinori Sato
2020-02-23 6:51 ` [PATCH v31 22/22] qemu-doc.texi: Add RX section Yoshinori Sato
2020-02-23 7:06 ` [PATCH v31 00/22] Add RX archtecture support no-reply
2020-02-23 7:27 ` no-reply
2020-02-23 7:37 ` no-reply
2020-02-23 7:57 ` no-reply
2020-02-23 8:04 ` no-reply
2020-02-23 8:15 ` no-reply
2020-02-23 8:29 ` no-reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c044121d-d933-f4e7-184b-1b9f171a541d@redhat.com \
--to=eblake@redhat.com \
--cc=aleksandar.m.mail@gmail.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
--cc=wainersm@redhat.com \
--cc=ysato@users.sourceforge.jp \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).