Re: [Qemu-devel] [PATCH] block: Deprecate bdrv_set_read_only() and users

[Paolo Bonzini]

On 08/11/2017 12:51, Kevin Wolf wrote:
> Am 08.11.2017 um 11:49 hat Daniel P. Berrange geschrieben:
>> On Wed, Nov 08, 2017 at 11:44:01AM +0100, Paolo Bonzini wrote:
>>> I am not sure this counts as deprecation, but it should go in the
>>> release notes as "future incompatible changes", and that section
>>> probably should go in qemu-doc.texi itself.
>>
>> Yeah, adding a "Incompatible changes" appendix to the qemu-doc.texi
>> would be useful, listing the planned change, and when it is actually
>> made. That way apps adding support for a feature have an indication
>> of any incompatiblities they might need to care about.
> 
> You mean a section containing future incompatible changes as well as
> already implemented incompatible changes?
> 
> What would we do with the existing "Deprecated features" section? Would
> it become a subsection of "Incompatible changes"? Or would we just
> rename it and the subsections would stay on the same level and get
> "deprecated" added to their title? Or a completely different structure?
> 
> I'm okay with adding a little documentation in this patch if I know what
> it should look like, but if it turns into a major overhaul of the
> documentation on incompatible changes, it's probably out of scope for
> this patch.

For now I would just add a section to the changelog.  That ensures that
we don't forget and end up doing nothing.

Paolo