[FFmpeg-devel] [PATCH] Changelog/ReleaseNotes: prepare for 2.4

[Andreas Cadhalpun]

On 14.09.2014 08:33, Clément Bœsch wrote:
> From: Clément Bœsch <clement at stupeflix.com>
>
> ---
>   Changelog     |  2 +-
>   RELEASE_NOTES | 19 ++++++++++++++-----
>   2 files changed, 15 insertions(+), 6 deletions(-)
>
> diff --git a/Changelog b/Changelog
> index c5185f7..480a298 100644
> --- a/Changelog
> +++ b/Changelog
> @@ -5,7 +5,7 @@ version <next>:
>   - Icecast protocol
>   - ported lenscorrection filter from frei0r filter
>   - large optimizations in dctdnoiz to make it usable
> -- request Icecast metadata by default
> +- ICY metadata are now requested by default with the HTTP protocol
>   - support for using metadata in stream specifiers in fftools
>   - LZMA compression support in TIFF decoder
>   - support for H.261 RTP payload format (RFC 4587)
> diff --git a/RELEASE_NOTES b/RELEASE_NOTES
> index a8b19c5..b3b7f7b 100644
> --- a/RELEASE_NOTES
> +++ b/RELEASE_NOTES
> @@ -2,13 +2,18 @@
>    │ RELEASE NOTES for FFmpeg 2.4 "Fresnel" │
>    └────────────────────────────────────────┘
>
> -   The FFmpeg Project proudly presents FFmpeg 2.4 "Fresnel", ...
> -   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'.
> +   The FFmpeg Project proudly presents FFmpeg 2.4 "Fresnel", just 2 months
> +   after the release of 2.3. Since this wasn't a long time ago, the Changelog
> +   is a bit small this time.

I think 'a bit short' would sound better.

> +   The most important thing in this release is the major bump of the libraries.

Maybe expand that to 'major version bump'.

> +   This means that this release is not ABI-compatible nor exactly API-

'neither ABI-compatible nor'

And I would replace 'exactly' with 'fully', because it is otherwise not 
exactly unambiguous. ;)

> +   compatible. But on the other hand it is aligned with the Libav 11 release
> +   series, and will as a result probably end up being maintained for a long
> +   time.
>
>      ┌────────────────────────────┐
> -   │ *  API Information         │
> +   │ ��  API Information         │
>      └────────────────────────────┘
>
>        FFmpeg 2.4 includes the following library versions:
> @@ -28,6 +33,7 @@
>            cause crashes, if it is not initialized.
>          • Some deprecated functions were removed.
>          • The avfilter_graph_parse function was made compatible with Libav.
> +       • The matroska demuxer now outputs verbatim ASS packets
                                                                  ^
There should be a dot at the end.

>        Please refer to the doc/APIChanges file for more information.
                                     ^
You didn't change this line, but there is a typo, as the file is called 
APIchanges with lower-case 'c'.

> @@ -41,6 +47,8 @@
>
>       • Icecast protocol
>       • API for live metadata updates through event flags.
                                                            ^
This dot is inconsistent with the other points in this list.

> +    • UTF-16 support in text subtitles formats
> +    • the ASS muxer now honor re-order the Dialogue events properly
>
>      ┌────────────────────────────┐
>      │ libavfilter                │
> @@ -66,3 +74,4 @@
>     • libmodplug is now detected through pkg-config
>     • HTML documentation generation through texi2html is deprecated in
>       favor of makeinfo/texi2any
> +  • ICY metadata are now requested by default with the HTTP protocol

Otherwise looks good.

Best regards,
Andreas