Puritan

Puritan

Source code. README. Latest version: ui: e7a6bdb6, compilation: 8b944b2d.

Note: very new code with automatic package caching and improved handling of Ctrl-C! Please test!

Puritan is a disk-image compiler which converts source material including packages, activities, and hacks into installable disk images. It consists of two pieces: a UI and a family of compilations (example). The compilations are simple Python programs which populate a filesystem with the materials you supply, then format it for distribution. The UI runs the compilations in a controlled environment created by Mock and configured according to the compilation's bootstrap and dependencies files.

Puritan was developed as a replacement for Pilgrim but was never officially adopted by OLPC. For details on the active OLPC build system, see Build system.

Principles

Puritan is based on several fundamental principles.

1. Tools should be usable for both decentralized and centralized patterns of development.
2. People **will** want to make unpackaged changes to their builds.
3. Caching matters.
4. Interactive development matters.
5. Build reproducibility matters.
6. Error-detection, handling, and cleanup matter.
7. People working on the OLPC build system will become accustomed to git and python.

Instructions

Preparation

To use Puritan, you need to install dependencies:

 # NB: mock >= 0.9.7 is needed.
 # debian:
 sudo apt-get install mock git-core
 # fedora:
 sudo yum install mock git-core
 # both
 sudo usermod -a -G mock $USER
 newgrp mock

and to check out and run a 'ui' and a 'compilation'.

 (git clone git://dev.laptop.org/users/mstone/puritan compilation; cd compilation; git branch --track 767 origin/767; git checkout 767)
 git clone git://dev.laptop.org/users/mstone/puritan ui
 python2.5 ui/puritan/main.py   # read help
 sudo python2.5 ui/puritan/main.py -v build ./compilation HEAD ./results -- -i

Interactive Debugging

The '-i' option above enables an interactive error-handling mode. If an error occurs,

with the most recent compilation and ui, you will be dropped directly into bash inside the buildroot.

• to resume the compilation, type

 exit 0

• to quit the compilation, type

 exit 1

with earlier compilations which still support interactive error-handling: instructions

Other Notes

Fedora

Note: if you encounter permission errors when running this command, you may need to:

 sudo setenforce 0  # disable selinux

Note: a word of warning: while _my_ uis and compilations will treat your computer nicely, other people's might not. Caveat emptor.

Ubuntu

mock_0.9.7-2 on ubuntu requires [1] in order to run. Additionally, if you run puritan as root, you should either

usermod -a -G mock -u $SUDO_UID
unset SUDO_UID  # or

All

Some puritan compilations now feature a 'download' operation which can be used to download all packages that the compilation will install for later (offline) use:

 sudo python2.5 ui/puritan/main.py -v download ./compilation HEAD ./results 

This command will generate a program in the results directory which can be used to download the packages.

Configuration

Puritan is highly and easily configurable by means of small modifications to the files and directories contained in each compilation. Detailed suggestions on how to configure Puritan are available.

Notes and Tricks

• Use the source, Luke! (It was written to be read!)
• with some uis and compilations, various subcommands (e.g. 'build') may fail because /etc/mock/fedora-9-i386.cfg is not present in Debian's mock package 0.9.7-2
  • one workaround is to create it from http://teach.laptop.org/~mstone/fedora-9-i386.cfg.
• Mock and SElinux do not interact very well.
  • at least one workaround is discussed on the Fedora MockTricks] page.
  • the author simply disables selinux with sudo setenforce 0 in order to avoid the hassle.
• Meld is a great tool for diffing the filesystem trees produced by the 'produce_tree' build stage and for comparing your builds to those made by others.
• Git will be your friend, but, to get the most out of the relationship, you're going to have to invest in it. Ask for help when you need it!
  • gitk --all or git log will show you lots of other compilations you could run!
• The latest compilation now automatically caches packages in a directory called 'smart/packages' inside the compilation. Some other state is also cached, so if things start behaving strangely, try deleting the 'smart' directory.

Help Out

Puritan was designed from the ground up to support decentralized development because its author felt that deployment autonomy was going to be critical to the success of the OLPC project. Therefore, please use your autonomy! In particular, please help improve puritan by:

• Using it! As much as you can! Produce cool disk images! Publish your patches! (patch review available on request).
• Making puritan work on your platform - it's only dependencies are python2.5, git-core, and mock!
• Maintaining the devel_ext3 compilation
• Adding some reasonable automatic package or buildroot caching system so that it runs faster without impairing build repeatability
• Improving the UI with commands for manipulating compilations, or for diffing builds, or for profiling compilations, or ...

Image Builder

If you are looking for a simpler and way of making a build, please have a look at Image Builder.

Image builder is a script which allows you to take an official OS image released by OLPC, and add in your own customizations. It is primarily intended for adding activities (.xo) and content bundles (.xol), but advanced users can script other customizations too.