[FFmpeg-devel] [FFmpeg-cvslog] doc: document the addition of the AVProbeData.mime_type field and it' s implications

[Andreas Cadhalpun]

On 13.09.2014 15:25, Michael Niedermayer wrote:
> On Sat, Sep 13, 2014 at 08:24:39AM +0200, Clément Bœsch wrote:
>> On Sat, Sep 13, 2014 at 12:53:21AM +0200, Andreas Cadhalpun wrote:
>>> ffmpeg | branch: master | Andreas Cadhalpun <Andreas.Cadhalpun at googlemail.com> | Fri Sep 12 18:18:42 2014 +0200| [d5e802609a0046441798cdbd137c96e4aa912390] | committer: Michael Niedermayer
>>>
>>> doc: document the addition of the AVProbeData.mime_type field and it's implications
>>>
>>> Signed-off-by: Andreas Cadhalpun <Andreas.Cadhalpun at googlemail.com>
>>> Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
>>>
>>>> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=d5e802609a0046441798cdbd137c96e4aa912390
>>> ---
>>>
>>>   RELEASE_NOTES  |    3 +++
>>>   doc/APIchanges |    3 +++
>>>   2 files changed, 6 insertions(+)
>>>
>>> diff --git a/RELEASE_NOTES b/RELEASE_NOTES
>>> index 113cc5e..14513a7 100644
>>> --- a/RELEASE_NOTES
>>> +++ b/RELEASE_NOTES
>>> @@ -54,6 +54,9 @@
>>>    │ ⚠  Behaviour changes       │
>>>    └────────────────────────────┘
>>>
>>> +  • IMPORTANT: The new field mime_type was added to AVProbeData.
>>> +    To avoid crashes, make sure to always initialize AVProbeData, e.g. use
>>> +    'AVProbeData pd = { 0 };' instead of 'AVProbeData pd;'.
>>
>> I don't think we should mix API and UI in this file. The second sentence
>> can be moved to doc/APIchanges, that's what this file is used for. We
>> mention doc/APIchanges in that RELEASE_NOTES: "Please refer to the
>> doc/APIChanges file for more information."

Indeed, that is a good idea. But still the other sentence doesn't really 
fit into the 'Behaviour changes' section, so I moved it to the 'API 
Information' section, where it fits much better and is directly followed 
by the pointer to doc/APIChanges.

In the attached patch I also changed the text at the beginning to only 
claim that the API is mostly compatible and minimal source changes might 
be needed.

Best regards,
Andreas
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-don-t-mix-API-and-UI-changes-in-the-Behaviour-ch.patch
Type: text/x-diff
Size: 2767 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20140913/811abc65/attachment.bin>