Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Drake <dsd@laptop.org>2012-03-21 17:15:29 (GMT)
committer Daniel Drake <dsd@laptop.org>2012-03-21 19:28:07 (GMT)
commit5dc8e8e81c17aa87f0dff82237bbfce8a5b11d8f (patch)
tree6ec1d999fb184761d629cb8d6a445098fe9c188d /doc
parentbc27437835ddf0c9cc339bd20129d2c524b10af9 (diff)
New build number naming scheme
As recently discussed on the devel list, we switch to a new naming scheme for builds, encompassing more details than before. See http://wiki.laptop.org/go/Release_Process#Version_numbering for more info. The name is now built from: 1. Fourth digit of the four-digit year corresponding to the Major Release 2. The release number within the current year 3. Three-digit zero-padded build number 4. An alphabetic 'deployment identifier', max 2 characters 5. A numeric code identifying the target laptop model.
Diffstat (limited to 'doc')
-rw-r--r--doc/README35
1 files changed, 25 insertions, 10 deletions
diff --git a/doc/README b/doc/README
index 9cbebae..ad79946 100644
--- a/doc/README
+++ b/doc/README
@@ -135,24 +135,28 @@ olpc_version_release
in the OS image. For example, in the OLPC OS 10.1.0 release, this
would be 0.
-image_name
-
- The naming scheme to use for the output files. The value of this field
- must include "%%d", this will be replaced with the build number.
- For example, a value of "per%%d-6" would result the output being called
- "per703-6" for build number 703. The default value is "os%%d".
- The reason that 2 percentage signs are needed is because RawConfigParser
- is in use; a % therefore triggers the INI interpolation feature, unless
- presented in the escaped form %%.
-
customization_info
+ This identifier will be displayed in the Sugar control panel and
+ in other places on the system, to indicate the source of the OS
+ build.
+
Please set this to a string that indicates your identity, to make
clear that the resultant build is a modified version of OLPC's
official release. For example, you could use something like
"customized for Paraguay" when producing an OS build for OLPC's
Paraguayan deployment.
+customization_tag
+
+ This tag will be included in the names of the output files, as a quick
+ way of identifying origin. The default value is "xx".
+
+ Please set this to a tag (one or two characters) representing your
+ identity. Your two-letter country code may be a good choice here.
+ For example, for the OLPC Paraguay project, "py" would be a sensible
+ choice. "o" is used by OLPC.
+
target_platform
A textual description of the target platform for the build, for
@@ -171,6 +175,17 @@ adapting all of the module code to work with the ever-changing
components of each official Fedora release.
+Output:
+
+At the end of the process, a series of filenames are saved in an output
+directory. The path to this directory is printed at the end of the process.
+Files within this directory are named according to a version scheme
+encompassing the major and minor version number, the build numer, the target
+laptop model, and the customisation tag. See
+http://wiki.laptop.org/go/Release_Process#Version_numbering for more details
+on this scheme.
+
+
Design goals:
- revolve around Fedora's image-creator infrastructure, meaning that