[FFmpeg-devel] [PATCH] */version.h: Add note/recommandition about bumping major

[Michael Niedermayer]

From: Michael Niedermayer <michael at niedermayer.cc>

If preferred, i can also apply this after the bump, in case its felt that
this would cause too much delay/work

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
---
 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 1b37a9e..cf9c924 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 3ddba0c..e2b4b95 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 653f530..c0b13c6 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.
+ *
  * @{
  */
 
-- 
1.7.9.5