judge_version_increase: add examples on what the checks are doing

1 files changed, 8 insertions, 0 deletions

diff --git a/mgagnome b/mgagnome
index 83b9618..61dcb97 100755
--- a/mgagnome
+++ b/mgagnome
@@ -89,9 +89,11 @@ def judge_version_increase(version_old, version_new):
         compare = version_cmp(version_new, version_old)
 
         if compare == 0:
+            # 1.0.0 -> 1.0.1
             return (-2, "Already at version %s!" % (version_old))
 
         if compare != 1:
+            # 1.0.1 -> 1.0.0
             return (-3, "Version %s is older than current version %s!" % (version_new, version_old))
 
         # Version is newer, but we don't want to see if it follows the GNOME versioning scheme
@@ -112,6 +114,7 @@ def judge_version_increase(version_old, version_new):
         # Major+minor the same? Then go ahead and upgrade!
         if majmins[0] == majmins[1]:
             # Majmin of both versions are the same, looks good!
+            # 1.1.x -> 1.1.x or 1.0.x -> 1.0.x
             return (10, None)
 
         # More detailed analysis needed, so figure out the numbers
@@ -119,6 +122,7 @@ def judge_version_increase(version_old, version_new):
 
         # Check/ensure major version number is the same
         if majmin_nrs[0][0] != majmin_nrs[1][0]:
+            # 1.0.x -> 2.0.x
             return (1, "Major version number increase")
 
         # Minor indicates stable/unstable
@@ -127,15 +131,19 @@ def judge_version_increase(version_old, version_new):
         # Upgrading to unstable is weird
         if not devstate[1]:
             if devstate[0]:
+                # 1.2.x -> 1.3.x
                 return (1, "Stable to unstable increase")
 
+            # 1.3.x -> 1.5.x
             return (4, "Unstable to unstable version increase")
 
         # Unstable => stable is always ok
         if not devstate[0]:
+            # 1.1.x -> 1.2.x
             return (5, "Unstable to stable")
 
         # Can only be increase of minors from one stable to the next
+        # 1.0.x -> 1.2.x
         return (6, "Stable version increase")
 
 def line_input (file):