From 0b7829901bc93af8407bfb832049d3d97c881c62 Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Tue, 18 Aug 2015 12:28:17 +0200 Subject: [PATCH] */version.h: Add note/recommandition about bumping major Reviewed-by: Andreas Cadhalpun Signed-off-by: Michael Niedermayer --- libavcodec/version.h | 4 ++++ libavformat/version.h | 5 +++++ libavutil/version.h | 4 ++++ 3 files changed, 13 insertions(+) diff --git a/libavcodec/version.h b/libavcodec/version.h index a118d5b2232..c38918eb3e1 100644 --- a/libavcodec/version.h +++ b/libavcodec/version.h @@ -46,6 +46,10 @@ * 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 * 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 diff --git a/libavformat/version.h b/libavformat/version.h index 3ddba0c8723..e2b4b959fcf 100644 --- a/libavformat/version.h +++ b/libavformat/version.h @@ -47,6 +47,11 @@ * 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 * 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 #define FF_API_LAVF_BITEXACT (LIBAVFORMAT_VERSION_MAJOR < 57) diff --git a/libavutil/version.h b/libavutil/version.h index 5dc3181ebe8..ccc85be3f5c 100644 --- a/libavutil/version.h +++ b/libavutil/version.h @@ -77,6 +77,10 @@ * 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. * + * @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. + * * @{ */ -- 2.39.2