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

Michael Niedermayer git at videolan.org
Wed Aug 19 21:39:21 CEST 2015


ffmpeg | branch: master | Michael Niedermayer <michael at niedermayer.cc> | Tue Aug 18 12:28:17 2015 +0200| [0b7829901bc93af8407bfb832049d3d97c881c62] | committer: Michael Niedermayer

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

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

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=0b7829901bc93af8407bfb832049d3d97c881c62
---

 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 a118d5b..c38918e 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 5dc3181..ccc85be 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.
+ *
  * @{
  */
 



More information about the ffmpeg-cvslog mailing list