|author||Pablo Neira Ayuso <firstname.lastname@example.org>||2010-07-15 11:07:55 +0200|
|committer||Pablo Neira Ayuso <email@example.com>||2010-07-15 11:07:55 +0200|
build: add notice on how to update library API version
Signed-off-by: Pablo Neira Ayuso <firstname.lastname@example.org>
Diffstat (limited to 'Make_global.am')
1 files changed, 19 insertions, 3 deletions
diff --git a/Make_global.am b/Make_global.am
index e52eb90..4d56685 100644
@@ -1,7 +1,23 @@
# This is _NOT_ the library release version, it's an API version.
-# Please read Chapter 6 "Library interface versions" of the libtool
-# documentation before making any modification
+# Extracted from Chapter 6 "Library interface versions" of the libtool docs.
+# Here are a set of rules to help you update your library version information:
+# 1. Start with version information of `0:0:0' for each libtool library.
+# 2. Update the version information only immediately before a public release
+# of your software. More frequent updates are unnecessary, and only guarantee
+# that the current interface number gets larger faster.
+# 3. If the library source code has changed at all since the last update,
+# then increment revision (`c:r:a' becomes `c:r+1:a').
+# 4. If any interfaces have been added, removed, or changed since the last
+# update, increment current, and set revision to 0.
+# 5. If any interfaces have been added since the last public release, then
+# increment age.
+# 6. If any interfaces have been removed since the last public release, then
+# set age to 0.