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

[Andreas Cadhalpun]

On 14.09.2014 01:29, Michael Niedermayer wrote:
On Sun, Sep 14, 2014 at 01:05:45AM +0200, Andreas Cadhalpun wrote:
On 14.09.2014 00:43, Michael Niedermayer wrote:
note, i will release 2.4 tomorrow (2014-09-14) or rather i intend
to. So anything that isnt pushed to the RELEASE_NOTES by then wont
be in it

OK, so attached are two hopefully uncontroversial patches, one
changing RELEASE_NOTES to only claim that the API is mostly
compatible and the other to add Clément's wording to doc/APIChanges.

I still think it would be good to mention the AVProbeData.mime_type
problem in the RELEASE_NOTES, but if there is a strong preference
not to do this, then so be it.

ive no preference at all except that i want the RELEASE_NOTES file to
be ok for release and everyone happy with whats written in it

I see.

[...]

     The FFmpeg Project proudly presents FFmpeg 2.4 "Fresnel", ...
-   FFmpeg 2.4 is API-, but not ABI-compatible with the previous major release.
-   This means that the code using our libraries needs to be rebuilt, but no
+   FFmpeg 2.4 is mostly API-, but not ABI-compatible with the previous major 
release.
+   This means that the code using our libraries needs to be rebuilt, but only 
minimal
     source changes should be required.

this should probably point to what changes these are or to a list
like the "Behaviour changes" section

The problem is that there currently is no such list. The only 
information about these so far is doc/APIchanges, which is quite 
verbose, so that important changes can easily be missed.

What do you think about adding a short list of these in the 'API 
Information' section, like attached patch does.

Best regards,
Andreas
>From ce447d98dde8974aac759bfeab89219c2825f969 Mon Sep 17 00:00:00 2001
From: Andreas Cadhalpun <andreas.cadhal...@googlemail.com>
Date: Sun, 14 Sep 2014 02:08:08 +0200
Subject: [PATCH] doc: mention important API changes in the RELEASE_NOTES

Signed-off-by: Andreas Cadhalpun <andreas.cadhal...@googlemail.com>
---
 RELEASE_NOTES | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/RELEASE_NOTES b/RELEASE_NOTES
index d30b863..a8b19c5 100644
--- a/RELEASE_NOTES
+++ b/RELEASE_NOTES
@@ -3,9 +3,9 @@
  └────────────────────────────────────────┘
 
    The FFmpeg Project proudly presents FFmpeg 2.4 "Fresnel", ...
-   FFmpeg 2.4 is API-, but not ABI-compatible with the previous major release.
-   This means that the code using our libraries needs to be rebuilt, but no
-   source changes should be required.
+   FFmpeg 2.4 is mostly API-, but not ABI-compatible with the previous major release.
+   This means that the code using our libraries needs to be rebuilt, but only minimal
+   source changes should be required, as described in the section 'API Information'.
 
    ┌────────────────────────────┐
    │ *  API Information         │
@@ -22,6 +22,13 @@
        • libswresample   1.1.100
        • libpostproc    53.0.100
 
+     Important API changes since 2.3:
+
+       • The new field mime_type was added to AVProbeData, which can
+         cause crashes, if it is not initialized.
+       • Some deprecated functions were removed.
+       • The avfilter_graph_parse function was made compatible with Libav.
+
      Please refer to the doc/APIChanges file for more information.
 
  ┌────────────────────────────┐
@@ -54,9 +61,6 @@
  │ ⚠  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;'.
   • dctdnoiz filter now uses a block size of 8x8 instead of 16x16 by default
   • -vismv option is deprecated in favor of the codecview filter
   • libmodplug is now detected through pkg-config
-- 
2.1.0

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel