bmap: increase minor version number
authorArtem Bityutskiy <artem.bityutskiy@intel.com>
Thu, 18 Oct 2012 08:37:38 +0000 (11:37 +0300)
committerArtem Bityutskiy <artem.bityutskiy@intel.com>
Fri, 19 Oct 2012 14:13:10 +0000 (17:13 +0300)
We've done some compatible changes and it is a good idea to incread the
minor bmap version number now.

Also, add some XML comments explaining the versioning.

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
mic/imager/raw.py

index 4e50a98..31f3902 100644 (file)
@@ -533,9 +533,16 @@ class RawImageCreator(BaseImageCreator):
 
         xml += "     Note, this file contains commentaries with useful information\n"
         xml += "     like image size in gigabytes, percentage of mapped data, etc.\n"
-        xml += "     This data is there merely to make the XML file human-readable. -->\n\n"
-
-        xml += "<bmap version=\"1.0\">\n"
+        xml += "     This data is there merely to make the XML file human-readable.\n\n"
+
+        xml += "     The 'version' attribute is the block map file format version in\n"
+        xml += "     the 'major.minor' format. The version major number is increased\n"
+        xml += "     whenever we make incompatible changes to the block map format,\n"
+        xml += "     meaning that the bmap-aware flasher would have to be modified in\n"
+        xml += "     order to support the new format. The minor version is increased\n"
+        xml += "     in case of compatible changes. For example, if we add an attribute\n"
+        xml += "     which is optional for the bmap-aware flasher. -->\n"
+        xml += "<bmap version=\"1.1\">\n"
         xml += "\t<!-- Image size in bytes (%s) -->\n" \
                 % misc.human_size(image_size)
         xml += "\t<ImageSize> %u </ImageSize>\n\n" % image_size