Release Process: Difference between revisions

From OLPC
Jump to navigation Jump to search
 
(224 intermediate revisions by 18 users not shown)
Line 1: Line 1:
{{Developers}}
= Release Process Overview =
{{Translations}}
This page describes OLPC's software release process.


== Goals ==
----
The goals of the release process process are to:


# Ensure high quality releases which meet the needs of users in a timely fashion.
Special thanks to Charles Merriam for helping show the way <br>
# Maximize the participation, productivity and enthusiasm of the open source community.
http://lists.laptop.org/pipermail/devel/2008-April/012318.html
# Create a predictable process which helps users and developers plan for the future.


== The output ==
and to Michael Stone for creating most of the existing pages and spending time getting me up to speed on how its done now.


The output of this process is a generic software image suitable for installation on OLPC's XO laptop platform. The image is generic in the sense that it includes a rounded selection of activities, applications, and languages.
This is a first draft. Please send comments, questions and suggestions to greg at laptop.org


We do not expect established deployments to use this software image directly. Almost all deployments have needs or desires to customise the software image that they ship (e.g. with new languages, a different selection of activities, specific default settings, etc.). We expect that most established deployments will use the [[Build system]] to produce a variant of the release including their own customizations.
[[User:Gregorio|Gregorio]] 08:46, 27 June 2008 (UTC) (UTC)


Nevertheless, the process of developing and stabilising the generic release is key, as it forms the base of all the deployment-customized software releases.
----


The goals of this process are:
== The process ==


Each release is planned in advance, and this process results in a slightly different development/release methodology for each release. However, certain guidelines and well-established principles are stuck to:
- Ensure high quality releases which meet the needs of users in a timely fashion. <br>
- Maximize the participation, productivity and enthusiasm of the open source community. <br>
- Create a predictable process on which users and developers can use to plan for future work. <br>


* The release planning documentation is made public from the start.
This process does not cover activity development. It only covers "core OS" (full list of modules tbd).
* Release development is divided into individual stages, separated by milestones (discussed below)
* Releases are coordinated according to a schedule of milestones, which is decided early on, and included in the release plan.
** This is important so that our customers know when to expect the final release, when they should get involved with development and testing, and to allow them to plan their upgrade/rollout.
** This is also a well-established practice in our neighbouring open source communities
* The release schedule is honored strictly. That is, the milestone dates are adhered to, even if some sacrifices (such as exclusion of planned features which didn't arrive in time) are made. Some flexibility can be allowed for, but these should be exceptional cases only.


The development process is divided into distinct stages, with milestones to mark the progression from each one to another. '''Each of the items below links to an extensive explanation (including technical and managerial procedures) of each stage''', be sure to read them all if you want to become involved in the release process.
== Time-based Releases ==
# [[Release Process/Planning]]
# [[Release Process/Development]]
# [[Release Process/Stabilization]]
# [[Release Process/Release]]


== Major and minor releases ==
A Release consists of set of builds, documentation, an approved ECO, a completed [http://wiki.laptop.org/go/USR_Checklist checklist] and support as defined below.


Major releases include large platform changes (such as updating to the latest versions of Fedora & Linux) and addition of new features.
For example, the most recent Release as of this writing --[[User:Greg|Greg]] 14:09, 25 June 2008 (UTC) is 8.1.0.
It is documented here: http://wiki.laptop.org/go/OLPC_Update.1_Software_Release_Notes


Minor releases (a.k.a. point releases) are limited to the fixing of bugs which are affecting deployments, and occasionally include translation and locale updates (requested by deployments).
Each release will have a page linked from here: <br>
http://wiki.laptop.org/go/Releases


: This was previously adhered to quite strictly, but the recent minor releases in the 10.1 series have seriously blurred the lines between major and minor releases. This degrade of practice started when OLPC's development resources were downsized, meaning that there were no resources in sight to allow for a future major release, resulting in the relaxing of criteria on what could go into the minor release. However, now that OLPC's software team has grown a bit again, it is my hope that this previous practice can be restored, so I've documented it that way. Time will tell... -[[User:DanielDrake|DanielDrake]] 17:22, 9 February 2011 (UTC)
=== Major Releases (e.g. 8.1.0, 8.2.0, 9.1.0, 9.2.0) ===


== Features ==
Major updates which include significant new features will be released twice a year (one in the first half of the calendar year and one in the second half of the calendar year).


New major releases will include a set of new features, pioneered and developed by OLPC staff and community members. A feature is defined as a significant change or enhancement to the current version of XO software that may or may not include new packages. Our feature process should be driven by the needs and feedback of our customers (deployments) and our users (young children).
Each major release will be supported for a period of 1 year from the time the release process check list is complete: http://wiki.laptop.org/go/USR_Checklist The date in the "Release team final sign off" field defines the start of the 1 year support time frame.


Features are usually considered to meet one or more of the following objectives:
Support means that a minor release with bug fixes will be built at OLPC's discretion based on an discussion with customers and other stakeholders.
# Highly user visible changes
# Improvements or changes that require non-trivial cross-package integration
# Noteworthy enough to call out in the release notes
# Exciting new capabilities we can trumpet.


Some examples might include:
=== Minor Releases (e.g. 8.1.1, 8.1.2, 8.2.1, 8.2.2) ===
* New educational tools that will be used by children
Minor releases will focus on bug fixes and will come out as often as negotiated by customers and OLPC. Minor releases may include new features if the release manager and primary customers agree they are well tested and documented. Minor releases must be fully backward compatible with the major release that they are based on. That is, activities and APIs must continue to work as before.
* New features from upstream that we are making available on the XO for the first time
* Improvements to tools and infrastructure used by activity developers


OLPC plans which features to develop for each release according to its key principles and based on feedback from customers. During planning stages, a discussion will usually be started on the devel [[Mailing lists|mailing list]] in order to solicit input from the community, and to clearly communicate that the feature planning process is underway.
An example of a minor release would be the addition of support for an additional language.


Features can also enter releases through upstream projects. For example, a new feature added to GNOME will automatically enter an OLPC release once a release is made including that specific GNOME version. Some of these features may have direct impact on OLPC and are good candidates to be discussed in the release notes.
All the bug fixes and changes in a minor release will be tracked and recorded in a software ECO and included in the release notes. See the full minor release process definition at: http://wiki.laptop.org/go/Unscheduled_software_release_process


Features outside of OLPC's feature plan are also welcome to be contributed by interested individuals and deployments, providing that they meet the normal code acceptance criteria (open source, good code quality, good documentation, appointed maintainer, ...), and provided that they are accepted and included within the acceptable stages of the release schedule. In many cases, development of such features does not belong at the OLPC level, but rather in the upstream projects (for example, development of a new Sugar feature would fall entirely within the SugarLabs community, and would not need acceptance or review by OLPC).
The choice of time based releases is motivated by the its success in a growing number of open source projects. For examples, see the
Ubuntu (https://wiki.ubuntu.com/TimeBasedReleases) and Gnome projects (http://live.gnome.org/ReleasePlanning)


== Maintainability and sustainability ==
== Types of Builds ==
Each build consists of core OS which implements a feature set such as http://wiki.laptop.org/go/OLPC_8.1.1_Features. At the option of the build author, the build may or may not contain activities.


OLPC has historically made quite a few changes to standard open source software technologies (Linux, Fedora, etc) and this hurts us in every release cycle. We are now a small team and every release cycle we spend a lot of time bringing forward the the collection of OLPC-local changes.
One way of classifying a build is to identify its readiness to be a Release.


In recent times, this "delta" from upstream software has been greatly reduced. We need to keep working in that direction, which means strict controls on any new non-upstream changes being added. The most effective way to approach this is to get your changes upstream first.
There are four types of builds in that classification:


== Version numbering ==
# Released images - (a.k.a. "stable") with release notes and ECO. This is a signed image which does not need a developer key to install on an XO. (e.g. official-703; the OS component of the 8.1.0 Release)
# Release candidates - (a.k.a. "testing") release candidates which are in change control and may become official releases if it passes the test cycle. (e.g. candidate-708; tentatively the OS component of the 8.1.1 Release )
# Development images - (a.k.a. "unstable") - the latest image with the latest code but it is also likely to contain significant bugs. (e.g. joyride-2072)
# Experimental images - images which are not expected to work and which are used for creating major new functionality; typically a part of "topic branches". (e.g. faster-2072)


=== Release names ===
More details on available builds and how to get them are [http://wiki.laptop.org/go/OS_images here].


The release names are of the form "Y.H.NN"
See also http://wiki.laptop.org/go/Build_system.
* Y = target calendar year
* H = major release number representing first release or second release of the calendar year
* NN represents the Minor Release, starting with .0 at the availability of the first Major Release and going up by 1 for each publicly available minor release after that.


A Major Release and all its derivative Minor Releases can be referred to with a variable (or wildcard) in the third digit (e.g. 8.2.x refers to 8.2.0, 8.2.1 and 8.2.3).
For a developer wanting to contribute new code we recommend the following steps:


Examples:
# Decide whether you want to hack on activities, releases, bugs, or experimental features.
* 8.1.1: First Minor Release rebuild based on the first Major Release in 2008
# Choose the corresponding build type: released images, candidates, development images, or your own topic branch.
* 8.2.0: Second Major Release in 2008
# Send an e-mail to devel@lists.laptop.org and/or sugar@lists.laptop.org explaining your work and gathering feedback.
# Implement a basic first pass which compiles and shows the main idea. Post a link to its source to the same lists, preferably in a patch-like format.
# Revise as needed based on feedback.
# If possible, get the changes included in an upstream repository or, as appropriate, ask the list for details on how to package it locally for the XO.


=== Build number ===
Release candidates are the builds that may replace the current 'stable' designation. Release candidates are created during the execution of software engineering change orders. See details of ECO creation steps here http://wiki.laptop.org/go/Unscheduled_software_release_process and [http://wiki.laptop.org/go/OLPC_SW-ECO_5 Example ECO for 8.1.1]


Each release stream is composed of a series of builds: a number of development builds, followed by some release candidates, followed by a final build that consists of the official, final release. Each build has a unique number. As of 2012, the numbering scheme works as follows:
Note: each successful build generates products that can be installed on some system. For example, release builds contain disk images suitable for flashing to NAND, for consumption by OLPC update, for inspection on other systems, and for simulation in QEMU. Traditionally, important builds are announced on devel@lists.laptop.org.


Each Major Release resets build numbering to start at 1 for the first development build. Later builds will increment that number, starting with development builds. When stabilising, release candidates will continue the increment-by-one pattern until the final build is reached. For example, here is a hypothetical situation:
= Release Naming Convention =
The release names are of the form "Y.H.NN" <br>
Y = target calendar year <br>
H = major release number representing calendar year half (1 or 2) <br>
NN = minor release number <br>


* 12.1.0 enters development. The first build is build 1. Builds 2,3,4,5,...34 are produced during the development phase.
Examples <br>
* 12.1.0 enters final stabilisation. Builds 35, 36, 37 are published as release candidates.
8.1.1 First major release in CY08, maintenance rebuild 1. <br>
* The 12.1.0 release is finished. 12.1.0 build 37 is published as the official, final version.
8.2.0 Second major release in CY08 <br>
* 12.2.0 enters development. Build numbering resets to build 1. Development builds 1,2,3,4,...,25 are produced
* 12.2.0 enters final stabilisation. Builds 26,27,28 are published as release candidates.
* The 12.2.0 release is finished. 12.2.0 build 28 is published as the official, final version.


=== Build filenames ===
Recall that releases consist of a family of builds derived from a reference OS, along with "polish" like documentation, signatures, &etc.


As of 2012, the filenames of the release files produced by the [[build system]] are structured in the following manner:
This build family consists of a reference OS named: <br>
- official-nnn <br>
which lives on http://download.laptop.org/xo-1/os/official/. The word "official" means that it is a Release build (link to doc, etc.). The "nnn" is an integer uniquely identifying the source code. An example is official-703.


# Fourth digit of the four-digit year corresponding to the Major Release (the "Y" component above), e.g. "2" in 2012, "3" in 2013
Derivative builds may be created locally by anyone. However, crypographic signatures are required to enable "cheap" mass installation of the derivatives. No signatures are required if you are willing to use OLPC-supported [http://wiki.laptop.org/go/Customization_key USB customization] technology or if you request developer keys for all your machines.
# The release number within the current year (first or second release, the "H" component from above). For 12.2.0, thats "2".

# Three-digit zero-padded build number, e.g. 098
Derivative builds are named as follows: <br>
# An alphabetic 'deployment identifier', max 2 characters. OLPC will use "o", deployments may wish to use their two-letter country code.
- variant-nnn-n <br>
# A numeric code identifying the target laptop model.
The "variant" field is typically a short string identifying a deployment or language group such as "peru" or "en". When the build name does not start with "official" it means that either:
# A '.'

# The file extension
* the reference operating system was customized to produce a derivative build, in which case the name will be as above, or
* a fork has taken place.

Examples:


The laptop model codes are:
For example, peru-703-6 is the customized build created for Peru based on the source code identified by 703. Another example is en-708-1 which is the English language customization of build 708. This is not an official Release unless and until official-708 is released and it is documented on the release page.
* XO-1: 0
* XO-1.5: 1
* XO-1.75: 2
* XO-3: 3
* XO-4: 4


For example, 21099o1.img is 12.1.x build 99 for XO-1.5 published by OLPC. 22031ni2.img is 12.2.0 build 31 for XO-1.5, for the OLPC Nicaragua project.
= Release Schedules =


If the deployment identifier code is limited to 2 characters, the resultant filename will adhere to the 8.3 limit (8 character filename, 3 character extension). This is the maximum filename length that can be read by the firmware when using VFAT-formatted USB media (this is common). This is why it is strongly recommended to limit the deployment identifier to two characters, although the build system does let you use more.
Getting a stable build out can be hard. A branch grows in stability over time and stability of the release and field testing the final release candidate takes time.


== Supported locales/languages ==
Step 1 - New Major Release is named. <br>


In the interest of keeping the image size down, OLPC only ships certain locales/translations in its released builds. New locales can be requested by writing to the devel [[mailing lists|mailing list]]. The criteria that must be met are:
Step 2 - Release objectives and lead customer identified. Target features listed and target date down to the month is chosen. <br>
* There is an active or soon-upcoming deployment (of any size) that is expected to use this language in the software release being targetted.
The module maintainer, with his peers and the community comes up with
* The development cycle for the targetted software release is at an appropriate point (i.e. open-development, not frozen) to accept changes of this scope
a set of features for the release. Product Management participates in the discussion
and informs it based of customers feedback. Product Management and the
relevant module maintainers are responsible to build consensus. The
module maintainers are responsible to ensure that the code going in
git repositories is consistent with that consensus. <br>


On one hand, the selection of locales included in OLPC's official builds is somewhat irrelevant, because we expect all significant deployments to use the [[build system]] to produce a customized version of each official release that they ship; the supported locales can be modified at this time.
Step 3 - Schedule is posted as follows. <br>


On the other hand, deployments should aim to become actively involved in the OLPC release process: updating, testing and refining their translations during the development stages of the release. This can't be done if OLPC's own releases don't include the locales/translations in question; asking deployments to regularly re-spin development builds is probably asking a bit much. So, deployments requesting inclusion of their specific locale makes a lot of sense, even if they will re-spin and customize the official release build when the time comes.
"Change Control (CC) of X" means that you need to convince the maintainer of X to merge your change instead of pushing it yourself.


== How to contribute ==
* 45 days before target date CC of Features. <br>
* 30 days before target date CC of the Release. <br>
* 15 days before target date CC of the Release Show Stoppers only <br>
* <15 days before target date Get consensus from test community, QA, and engineering. Then finish release check list. <br>
* Release day - Kim sends announcement e-mail approving release for production. <br>


=== Developing ===
'''Defintions <br>'''
=== Testing ===
* CC of Features
After this date only new features which are approved by module maintainers and Product Management are allowed in. Bug fixes can still be added without approval for another 15 days. All strings must be final by this time. All user interface changes must be final by this time.


=== Translation ===
* CC of the Release
All translation packages must be final by this time. <br>
On or before this date Module maintainers propose a set of bug fixes to get into the stable
branch. They usually do so by releasing a new version of their module
and informing the release team about the changes it contains and the
steps necessary to test those. The release team will make sure that
the relevant QA is executed and either approve the changes or ask for
fixes/improvements. As soon as the changes are approved they are added
to the stable build. After this date no changes are allowed in to the code without the approval of the module maintainer and the [http://wiki.laptop.org/go/Unscheduled_software_release_process#Triage_Team Release Triage team].


Translation of the Sugar user interface (UI) is primarily handled via the Pootle instance hosted by Sugar Labs on behalf of the broader Sugar Labs / OLPC / eToys communities.
* CC of the Release Show Stoppers
As of this date every single change to the source code needs to be approved by the
[http://wiki.laptop.org/go/Unscheduled_software_release_process#Release_Team Release Team] before it happens.


http://translate.sugarlabs.org/
= Release Steps =
Minor Releases follow the process outline here: <br>
http://wiki.laptop.org/go/Unscheduled_software_release_process


Documentation about the Translation Team and their processes can be found here:
In particular a Release must complete the checklist: <br>
http://wiki.laptop.org/go/USR_Checklist


http://wiki.sugarlabs.org/go/Translation_Team
A Major Release follows the process documented here: <br>
http://wiki.laptop.org/go/Plan_of_Record-2008/Draft_3#RM:_Release_Mechanisms


The Translation Team coordinates it's efforts via the Localization (L10n) list hosted on OLPC's Mailman instance:
= Release Goals and Request Prioritization =


http://lists.laptop.org/listinfo/localization
TBD.


Translation of the GNOME boot UI strings in OLPC Sugar / GNOME dual-boot images occurs in various upstream locations: the [http://l10n.gnome.org/releases/olpc/ GNOME L10n server], the Fedora Transifex server, and the Translation Project. Specific upstream packages used by OLPC are [http://translate.sugarlabs.org/projects/upstream_l10n/ tracked] on Pootle and several upstream packages are collaboratively localized and hosted on Pootle [http://translate.sugarlabs.org/projects/upstream_POT/ (e.g. AbiWord and Gnash)].
Existing thinking on the current plan is here <br>
http://wiki.laptop.org/go/Plan_of_Record-2008/Draft_3


== See also ==
= Summary and Open Items =


* [[Release Process Home/Historical]] - historical plans for parts of the release process
The OLPC Build Process is getting cleaner, faster, and more reliable. The new time-based release cycle provides the regularity needed by developers and users.


[[Category:Releases]]
Open items needing definition
* Create a schedule for 8.1.1 and 8.2.0
* Define feature and bug prioritization process
* Define release quality metrics and include test details and milestones
* Governance and community best practices guidelines
* Gather community buy in and consensus
* Finalize release and triage teams
* Review and finalize release details pages:
* Put it in to practice, revise and improve

Latest revision as of 04:32, 19 December 2013

  english | español HowTo [ID# 294137]  +/-  

This page describes OLPC's software release process.

Goals

The goals of the release process process are to:

  1. Ensure high quality releases which meet the needs of users in a timely fashion.
  2. Maximize the participation, productivity and enthusiasm of the open source community.
  3. Create a predictable process which helps users and developers plan for the future.

The output

The output of this process is a generic software image suitable for installation on OLPC's XO laptop platform. The image is generic in the sense that it includes a rounded selection of activities, applications, and languages.

We do not expect established deployments to use this software image directly. Almost all deployments have needs or desires to customise the software image that they ship (e.g. with new languages, a different selection of activities, specific default settings, etc.). We expect that most established deployments will use the Build system to produce a variant of the release including their own customizations.

Nevertheless, the process of developing and stabilising the generic release is key, as it forms the base of all the deployment-customized software releases.

The process

Each release is planned in advance, and this process results in a slightly different development/release methodology for each release. However, certain guidelines and well-established principles are stuck to:

  • The release planning documentation is made public from the start.
  • Release development is divided into individual stages, separated by milestones (discussed below)
  • Releases are coordinated according to a schedule of milestones, which is decided early on, and included in the release plan.
    • This is important so that our customers know when to expect the final release, when they should get involved with development and testing, and to allow them to plan their upgrade/rollout.
    • This is also a well-established practice in our neighbouring open source communities
  • The release schedule is honored strictly. That is, the milestone dates are adhered to, even if some sacrifices (such as exclusion of planned features which didn't arrive in time) are made. Some flexibility can be allowed for, but these should be exceptional cases only.

The development process is divided into distinct stages, with milestones to mark the progression from each one to another. Each of the items below links to an extensive explanation (including technical and managerial procedures) of each stage, be sure to read them all if you want to become involved in the release process.

  1. Release Process/Planning
  2. Release Process/Development
  3. Release Process/Stabilization
  4. Release Process/Release

Major and minor releases

Major releases include large platform changes (such as updating to the latest versions of Fedora & Linux) and addition of new features.

Minor releases (a.k.a. point releases) are limited to the fixing of bugs which are affecting deployments, and occasionally include translation and locale updates (requested by deployments).

This was previously adhered to quite strictly, but the recent minor releases in the 10.1 series have seriously blurred the lines between major and minor releases. This degrade of practice started when OLPC's development resources were downsized, meaning that there were no resources in sight to allow for a future major release, resulting in the relaxing of criteria on what could go into the minor release. However, now that OLPC's software team has grown a bit again, it is my hope that this previous practice can be restored, so I've documented it that way. Time will tell... -DanielDrake 17:22, 9 February 2011 (UTC)

Features

New major releases will include a set of new features, pioneered and developed by OLPC staff and community members. A feature is defined as a significant change or enhancement to the current version of XO software that may or may not include new packages. Our feature process should be driven by the needs and feedback of our customers (deployments) and our users (young children).

Features are usually considered to meet one or more of the following objectives:

  1. Highly user visible changes
  2. Improvements or changes that require non-trivial cross-package integration
  3. Noteworthy enough to call out in the release notes
  4. Exciting new capabilities we can trumpet.

Some examples might include:

  • New educational tools that will be used by children
  • New features from upstream that we are making available on the XO for the first time
  • Improvements to tools and infrastructure used by activity developers

OLPC plans which features to develop for each release according to its key principles and based on feedback from customers. During planning stages, a discussion will usually be started on the devel mailing list in order to solicit input from the community, and to clearly communicate that the feature planning process is underway.

Features can also enter releases through upstream projects. For example, a new feature added to GNOME will automatically enter an OLPC release once a release is made including that specific GNOME version. Some of these features may have direct impact on OLPC and are good candidates to be discussed in the release notes.

Features outside of OLPC's feature plan are also welcome to be contributed by interested individuals and deployments, providing that they meet the normal code acceptance criteria (open source, good code quality, good documentation, appointed maintainer, ...), and provided that they are accepted and included within the acceptable stages of the release schedule. In many cases, development of such features does not belong at the OLPC level, but rather in the upstream projects (for example, development of a new Sugar feature would fall entirely within the SugarLabs community, and would not need acceptance or review by OLPC).

Maintainability and sustainability

OLPC has historically made quite a few changes to standard open source software technologies (Linux, Fedora, etc) and this hurts us in every release cycle. We are now a small team and every release cycle we spend a lot of time bringing forward the the collection of OLPC-local changes.

In recent times, this "delta" from upstream software has been greatly reduced. We need to keep working in that direction, which means strict controls on any new non-upstream changes being added. The most effective way to approach this is to get your changes upstream first.

Version numbering

Release names

The release names are of the form "Y.H.NN"

  • Y = target calendar year
  • H = major release number representing first release or second release of the calendar year
  • NN represents the Minor Release, starting with .0 at the availability of the first Major Release and going up by 1 for each publicly available minor release after that.

A Major Release and all its derivative Minor Releases can be referred to with a variable (or wildcard) in the third digit (e.g. 8.2.x refers to 8.2.0, 8.2.1 and 8.2.3).

Examples:

  • 8.1.1: First Minor Release rebuild based on the first Major Release in 2008
  • 8.2.0: Second Major Release in 2008

Build number

Each release stream is composed of a series of builds: a number of development builds, followed by some release candidates, followed by a final build that consists of the official, final release. Each build has a unique number. As of 2012, the numbering scheme works as follows:

Each Major Release resets build numbering to start at 1 for the first development build. Later builds will increment that number, starting with development builds. When stabilising, release candidates will continue the increment-by-one pattern until the final build is reached. For example, here is a hypothetical situation:

  • 12.1.0 enters development. The first build is build 1. Builds 2,3,4,5,...34 are produced during the development phase.
  • 12.1.0 enters final stabilisation. Builds 35, 36, 37 are published as release candidates.
  • The 12.1.0 release is finished. 12.1.0 build 37 is published as the official, final version.
  • 12.2.0 enters development. Build numbering resets to build 1. Development builds 1,2,3,4,...,25 are produced
  • 12.2.0 enters final stabilisation. Builds 26,27,28 are published as release candidates.
  • The 12.2.0 release is finished. 12.2.0 build 28 is published as the official, final version.

Build filenames

As of 2012, the filenames of the release files produced by the build system are structured in the following manner:

  1. Fourth digit of the four-digit year corresponding to the Major Release (the "Y" component above), e.g. "2" in 2012, "3" in 2013
  2. The release number within the current year (first or second release, the "H" component from above). For 12.2.0, thats "2".
  3. Three-digit zero-padded build number, e.g. 098
  4. An alphabetic 'deployment identifier', max 2 characters. OLPC will use "o", deployments may wish to use their two-letter country code.
  5. A numeric code identifying the target laptop model.
  6. A '.'
  7. The file extension

The laptop model codes are:

  • XO-1: 0
  • XO-1.5: 1
  • XO-1.75: 2
  • XO-3: 3
  • XO-4: 4

For example, 21099o1.img is 12.1.x build 99 for XO-1.5 published by OLPC. 22031ni2.img is 12.2.0 build 31 for XO-1.5, for the OLPC Nicaragua project.

If the deployment identifier code is limited to 2 characters, the resultant filename will adhere to the 8.3 limit (8 character filename, 3 character extension). This is the maximum filename length that can be read by the firmware when using VFAT-formatted USB media (this is common). This is why it is strongly recommended to limit the deployment identifier to two characters, although the build system does let you use more.

Supported locales/languages

In the interest of keeping the image size down, OLPC only ships certain locales/translations in its released builds. New locales can be requested by writing to the devel mailing list. The criteria that must be met are:

  • There is an active or soon-upcoming deployment (of any size) that is expected to use this language in the software release being targetted.
  • The development cycle for the targetted software release is at an appropriate point (i.e. open-development, not frozen) to accept changes of this scope

On one hand, the selection of locales included in OLPC's official builds is somewhat irrelevant, because we expect all significant deployments to use the build system to produce a customized version of each official release that they ship; the supported locales can be modified at this time.

On the other hand, deployments should aim to become actively involved in the OLPC release process: updating, testing and refining their translations during the development stages of the release. This can't be done if OLPC's own releases don't include the locales/translations in question; asking deployments to regularly re-spin development builds is probably asking a bit much. So, deployments requesting inclusion of their specific locale makes a lot of sense, even if they will re-spin and customize the official release build when the time comes.

How to contribute

Developing

Testing

Translation

Translation of the Sugar user interface (UI) is primarily handled via the Pootle instance hosted by Sugar Labs on behalf of the broader Sugar Labs / OLPC / eToys communities.

http://translate.sugarlabs.org/

Documentation about the Translation Team and their processes can be found here:

http://wiki.sugarlabs.org/go/Translation_Team

The Translation Team coordinates it's efforts via the Localization (L10n) list hosted on OLPC's Mailman instance:

http://lists.laptop.org/listinfo/localization

Translation of the GNOME boot UI strings in OLPC Sugar / GNOME dual-boot images occurs in various upstream locations: the GNOME L10n server, the Fedora Transifex server, and the Translation Project. Specific upstream packages used by OLPC are tracked on Pootle and several upstream packages are collaboratively localized and hosted on Pootle (e.g. AbiWord and Gnash).

See also