Re: [PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes

[Peter Maydell]

On Fri, 14 Feb 2020 at 15:13, Markus Armbruster <address@hidden> wrote:
>
> Markus Armbruster <address@hidden> writes:
>
> > Peter Maydell <address@hidden> writes:
> >
> >> A handful of QAPI doc comments include lines like
> >> "ppcemb: dropped in 3.1". The doc comment parser will just
> >> put these into whatever the preceding section was; sometimes
> >> that's "Notes", and sometimes it's some random other section,
> >> as with "NetClientDriver" where the "'dump': dropped in 2.12"
> >> line ends up in the "Since:" section.
> >>
> >> This tends to render wrongly, more so in the upcoming rST
> >> generator, but sometimes even in the texinfo, as in the case
> >> of QKeyCode:
> >>    ac_bookmarks
> >>        since 2.10 altgr, altgr_r: dropped in 2.10
> >>
> >> We now have a better place to tell users about deprecated
> >> and deleted functionality -- qemu-deprecated.texi.
> >> So just remove all these "dropped in" remarks entirely.
>
> The first sentence makes me expect we'll move these bits to the better
> place.  The second then tells me we drop them, without giving a reason.
>
> Suggest:
>
>    Since commit 3264ffced3 (v4.2.0), we have a better place to tell
>    users about deprecated and deleted functionality --
>    qemu-deprecated.texi.  These "dropped in" remarks all predate it, and
>    other feature drops of that vintage are not documented anywhere, so
>    moving these to qemu-deprecated.texi makes little sense.  Drop them
>    instead.
>
> With something like that
> Reviewed-by: Markus Armbruster <address@hidden>

Yeah, I wrote the commit message on the assumption that we'd
be modifying the commit contents to include documenting this
stuff somewhere else. If we're happy not to document the
feature-drops at all then we can modify the commit message instead.

thanks
-- PMM