aboutsummaryrefslogtreecommitdiffstats
path: root/libavformat/version.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2015-08-18 12:28:17 +0200
committerMichael Niedermayer <michael@niedermayer.cc>2015-08-19 21:37:32 +0200
commit0b7829901bc93af8407bfb832049d3d97c881c62 (patch)
tree9a9c990a6674ca0361ec4ed5e1c7e57ff848b406 /libavformat/version.h
parent2edb7ab1cba6eefe6c838fa90363cf3fb2369728 (diff)
downloadffmpeg-0b7829901bc93af8407bfb832049d3d97c881c62.tar.gz
*/version.h: Add note/recommandition about bumping major
Reviewed-by: Andreas Cadhalpun <andreas.cadhalpun@googlemail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavformat/version.h')
-rw-r--r--libavformat/version.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/libavformat/version.h b/libavformat/version.h
index 3ddba0c872..e2b4b959fc 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)