Browse code

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

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

Michael Niedermayer authored on 2015/08/18 19:28:17
Showing 3 changed files
... ...
@@ -46,6 +46,10 @@
46 46
  * FF_API_* defines may be placed below to indicate public API that will be
47 47
  * dropped at a future version bump. The defines themselves are not part of
48 48
  * the public API and may change, break or disappear at any time.
49
+ *
50
+ * @note, when bumping the major version it is recommandeded to manually
51
+ * disable each FF_API_* in its own commit instead of disabling them all
52
+ * at once through the bump. This improves the git bissect-ability of the change.
49 53
  */
50 54
 
51 55
 #ifndef FF_API_VIMA_DECODER
... ...
@@ -47,6 +47,11 @@
47 47
  * FF_API_* defines may be placed below to indicate public API that will be
48 48
  * dropped at a future version bump. The defines themselves are not part of
49 49
  * the public API and may change, break or disappear at any time.
50
+ *
51
+ * @note, when bumping the major version it is recommandeded to manually
52
+ * disable each FF_API_* in its own commit instead of disabling them all
53
+ * at once through the bump. This improves the git bissect-ability of the change.
54
+ *
50 55
  */
51 56
 #ifndef FF_API_LAVF_BITEXACT
52 57
 #define FF_API_LAVF_BITEXACT            (LIBAVFORMAT_VERSION_MAJOR < 57)
... ...
@@ -77,6 +77,10 @@
77 77
  * dropped at a future version bump. The defines themselves are not part of
78 78
  * the public API and may change, break or disappear at any time.
79 79
  *
80
+ * @note, when bumping the major version it is recommandeded to manually
81
+ * disable each FF_API_* in its own commit instead of disabling them all
82
+ * at once through the bump. This improves the git bissect-ability of the change.
83
+ *
80 84
  * @{
81 85
  */
82 86