[maemo-commits] [maemo-commits] r9893 - projects/haf/trunk/hildon-theme-layout-4

[From: subversion at stage.maemo.org]

Author: mdk
Date: 2007-02-15 12:49:01 +0200 (Thu, 15 Feb 2007)
New Revision: 9893

Modified:
   projects/haf/trunk/hildon-theme-layout-4/ChangeLog
   projects/haf/trunk/hildon-theme-layout-4/README
Log:
Adding a small README about the versioning system for this package etc.


Modified: projects/haf/trunk/hildon-theme-layout-4/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-theme-layout-4/ChangeLog	2007-02-15 09:58:05 UTC (rev 9892)
+++ projects/haf/trunk/hildon-theme-layout-4/ChangeLog	2007-02-15 10:49:01 UTC (rev 9893)
@@ -1,3 +1,8 @@
+2007-02-15  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
+
+	* README: Adding a small README about the versioning system for this
+	package etc.
+
 2007-02-14  Xan Lopez  <xan.lopez at nokia.com>
 
 	* rc/hildonnavigator.rc:

Modified: projects/haf/trunk/hildon-theme-layout-4/README
===================================================================
--- projects/haf/trunk/hildon-theme-layout-4/README	2007-02-15 09:58:05 UTC (rev 9892)
+++ projects/haf/trunk/hildon-theme-layout-4/README	2007-02-15 10:49:01 UTC (rev 9893)
@@ -1,2 +1,46 @@
-This is the theme support package for maemo/hildon 4
-----------------------------------------------------
+This is the theme support package for maemo
+-------------------------------------------
+
+It's representing the layout for the post-bora times.
+
+Versioning (x.y.z)
+------------------
+
+The relation between the themes and layouts is a static one, not dynamic (think:
+statically linked libraries). Therefore it's important to stick to a package
+versioning system so that the layout version can be discovered from the theme
+version itself. 
+
+The following basic rules apply to this layout package:
+
+1) y is increased each time the layout itself (cutting information) is changed.
+2) z is increased each time the rc data was modified
+
+Generally the themes have (should have) a dependency bound to the 'y' version of the 
+package. So, for example, a theme might depend on a layout > 1.4.x but < 1.5.x. So,
+increasing the y version of the layout WILL BREAK ALL THEMES BASED ON THIS
+LAYOUT (till they're fixed and the dependency is readjusted again). 
+
+This is intentional. It's meant to prevent the rebuild of the broken theme. y is
+shoulbe be changed each time the changes in the layout will render the children
+themes broken -- ie. changing the cutting information will render the themes
+broken as they have no proper graphics in the proper places. 
+
+Additionally, the platform version (or -- the major API version) is embedded in
+the name of the layout package. For example:
+
+        hildon-theme-layout-2 for mistral
+        hildon-theme-layout-3 for bora
+        ...
+
+It's handled in such a way since the user might want to have severall layouts
+(layout versions) installed at the same time. 
+
+The themes take this major API number as they major version number. For example:
+
+        hildon-theme-plankton 4.x.y is a theme based on hildon-theme-layout-4
+        hildon-theme-plankton 3.x.y is a theme based on hildon-theme-layout-3
+        ...
+
+(tbc)
+