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

Reviewed-by: Andreas Cadhalpun <andreas.cadhalpun@googlemail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

diff --git a/libavcodec/version.h b/libavcodec/version.h
index a118d5b2232047d897087d0393e6f78ea05416c0..c38918eb3e1414b62d06380be6aedb54ad419685 100644 (file)
--- 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 3ddba0c872345115ae74f1a5eaf8a7f5bd11302a..e2b4b959fcfb70c9c5ef381e11efb3259563b296 100644 (file)
--- 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 5dc3181ebe8d21dfb4abf4f7ae96f592943d5b37..ccc85be3f5c1203b0b6e678dd8c694a86045245a 100644 (file)
--- 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.
+ *
  * @{
  */