*/version.h: Add note/recommandition about bumping major

Reviewed-by: Andreas Cadhalpun <andreas.cadhalpun@googlemail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
pull/146/head
Michael Niedermayer 9 years ago
parent 2edb7ab1cb
commit 0b7829901b
  1. 4
      libavcodec/version.h
  2. 5
      libavformat/version.h
  3. 4
      libavutil/version.h

@ -46,6 +46,10 @@
* FF_API_* defines may be placed below to indicate public API that will be * FF_API_* defines may be placed below to indicate public API that will be
* dropped at a future version bump. The defines themselves are not part of * dropped at a future version bump. The defines themselves are not part of
* the public API and may change, break or disappear at any time. * the public API and may change, break or disappear at any time.
*
* @note, when bumping the major version it is recommandeded to manually
* disable each FF_API_* in its own commit instead of disabling them all
* at once through the bump. This improves the git bissect-ability of the change.
*/ */
#ifndef FF_API_VIMA_DECODER #ifndef FF_API_VIMA_DECODER

@ -47,6 +47,11 @@
* FF_API_* defines may be placed below to indicate public API that will be * FF_API_* defines may be placed below to indicate public API that will be
* dropped at a future version bump. The defines themselves are not part of * dropped at a future version bump. The defines themselves are not part of
* the public API and may change, break or disappear at any time. * the public API and may change, break or disappear at any time.
*
* @note, when bumping the major version it is recommandeded to manually
* disable each FF_API_* in its own commit instead of disabling them all
* at once through the bump. This improves the git bissect-ability of the change.
*
*/ */
#ifndef FF_API_LAVF_BITEXACT #ifndef FF_API_LAVF_BITEXACT
#define FF_API_LAVF_BITEXACT (LIBAVFORMAT_VERSION_MAJOR < 57) #define FF_API_LAVF_BITEXACT (LIBAVFORMAT_VERSION_MAJOR < 57)

@ -77,6 +77,10 @@
* dropped at a future version bump. The defines themselves are not part of * dropped at a future version bump. The defines themselves are not part of
* the public API and may change, break or disappear at any time. * the public API and may change, break or disappear at any time.
* *
* @note, when bumping the major version it is recommandeded to manually
* disable each FF_API_* in its own commit instead of disabling them all
* at once through the bump. This improves the git bissect-ability of the change.
*
* @{ * @{
*/ */

Loading…
Cancel
Save