On Tue, Jan 14, 2020 at 11:08:16AM +0100, Thomas Huth wrote:
On 13/01/2020 23.36, John Snow wrote:
Right now, we don't
really have these docs hosted in a searchable way online in a
per-version format. Once the notice is gone, it's gone from the mirror.
I removed some bitmap functionality not too long ago and I created a
"Recently Removed" section as a bit of a troubleshooting guide should it
be needed.
- Do we want this section?
- Should I remove it?
- Can we add historical docs to the website to see previous deprecated
docs in a searchable manner?
I also once started a page in the Wiki here:
https://wiki.qemu.org/Features/RemovedFeatures
... but apparently, it did not get enough attention yet, otherwise you
would have noticed it before introducing the new chapter into the
qemu-doc ...
We definitely need one spot where we can document removed features. I
don't mind which way we do it, either the qemu-doc or the wiki, but we
should unify on one of the two. I guess the qemu-doc is the better place
since we are tracking the deprecated features there already and one more
or less just has to move the text to the other chapter when things get
finally removed?
Yeah, I've said in the past that we should not be deleting deprecations
from the docs entirely.
If you look at GTK docs for example, you'll see they keep a record of
all incompatible or noteworth changes between release:
https://developer.gnome.org/gtk3/stable/gtk-migrating-3-x-to-y.html
IMHO, we should follow this and have an appendix of removed features,
with sub-sections per QEMU release listing each removed feature. Thus
deprecation docs just get moved to this appendix at the right time.