MokoMakefile

From Openmoko

(Difference between revisions)
Jump to: navigation, search
m (Requirements for building OpenMoko: Put distribution-specific package dependices into its own section)
m (added hint to Toolchain)
 
(134 intermediate revisions by 59 users not shown)
Line 1: Line 1:
==MokoMakefile==
+
{{Languages|MokoMakefile (OBSOLETE)}}
MokoMakefile is a simple Makefile which saves lots of work when setting up an OpenMoko build environment.
+
By automating the setup process of a new OpenMoko build environment, it provides an environment which is configured the same for all the existing developers and should therefore be preferred over manual procedures or individual setup procedures.
+
  
It brings the same repeatability to build environment creation and maintenance as that which the BitBake scripts bring to OpenEmbedded ease and standardize the process of building OpenEmbedded.
+
NOTE: According to the [http://mokomakefile.projects.openmoko.org/  source repository for MokoMakefile], this tool is obsolete. See [[Toolchain]] on how to develop for Openmoko.
  
Unlike the manual process described at [[Building OpenMoko from scratch]], MokoMakefile does not install anything into your system (it can and should be started as normal user).
+
MokoMakefile is a Makefile which saves lots of work when setting up an Openmoko build environment.
 +
By automating the setup process of a new Openmoko build environment, it provides an environment which is configured the same for all the existing developers and should therefore be preferred over manual procedures or individual setup procedures.
 +
It brings the same repeatability to build environment creation and maintenance as that which the BitBake scripts bring to [[OpenEmbedded]] ease and standardize the process of building OpenEmbedded.
  
MokoMakefile is a wrapper around all that to make it easy to set up and maintain a development environment that fully complies with the setup instructions published by OpenMoko.
+
MokoMakefile does not install anything into your system (it can and should be started as normal user). MokoMakefile is a wrapper around all that is required to make it easy to set up and maintain a development environment that fully complies with the setup instructions published by Openmoko.
  
MokoMakefile is developed by [[User:RodWhitby|Rod Whitby]] - it is not an official product of OpenMoko (although I would be happy for them to pick it up and use it internally).  If there is any discrepancy between the [[Building_OpenMoko_from_scratch|official OpenMoko build instructions]], and the operation of the MokoMakefile, then you should consider the official instructions to be correct.
+
MokoMakefile is developed by [[User:RodWhitby|Rod Whitby]] - '''it is not an official product of Openmoko''' (although I would be happy for them to pick it up and use it internally).  If there is any discrepancy between the [http://downloads.openmoko.org/build/|official Openmoko build instructions], and the operation of the MokoMakefile, then you should consider the official instructions to be correct.
  
The MokoMakefile is able to build either OM-2007.1 or OM-2007.2 images.  The core team chooses the default, but you can select one or the other at the top of the Makefile.
+
The MokoMakefile is able to build the stable, testing and unstable versions of the FSO distribution images.
  
=== Requirements for building OpenMoko ===
+
MokoMakefile no longer builds the QEMU-based Neo1973 emulator.
Independent on whether MokoMakefile or a manual process is used to setup an OpenMoko build environment, there are several requirements which must be fullfilled in order for the OpenMoko build to succeed:
+
  
* RAM: The build host needs to have at least 512MB of RAM, and about the same amount of swap. Some packages built by OpenEmbedded like busybox are built by compiling all source files into one binary which causes gcc to grow belond 300MB of size and no part of this memory may be on swap for the compile to finish in predictable time. For busybox, this can be turned off, but turning this off means that busybox will not as well optimized by gcc.
+
== Requirements for building Openmoko ==
 +
Independent on whether MokoMakefile or a manual process is used to setup an Openmoko build environment, there are several requirements which must be fulfilled in order for the Openmoko build to succeed:
  
* Disk space: You need about 12 GB of available disk space for the OpenMoko build to succeed (see below for a tip on how to reduce this).
+
* RAM: The build host needs to have at least 512MB of RAM, and about the same amount of swap. Some packages built by OpenEmbedded like busybox are built by compiling all source files into one binary which causes gcc to grow beyond 300MB of size and no part of this memory may be on swap for the compile to finish in predictable time. For busybox, this can be turned off, but turning this off means that busybox will not as well optimized by gcc.
  
* Software: gcc, gcc-c++, subversion and [http://monotone.ca monotone] and more (see below for distribution-specific hints)
+
* Disk space: You need about 12 GB of available disk space for the Openmoko build to succeed (see below for a tip on how to reduce this).
  
* Time: The initial build takes at least 5 hours (on 2GHz core2duo without multiprocessor optimization) and may take to several days on slower machines.
+
* Time: The initial build takes at least 5 hours (on 2GHz core2duo without multiprocessor optimization) and may take several days on slower machines.
 +
 
 +
=== Required software ===
 +
 
 +
Some distribution specific hints on preparing your build host for building [[OpenEmbedded]] are on http://wiki.openembedded.net/index.php/OEandYourDistro but they may be outdated, incomplete and do not cover everything which Openmoko needs to build.
 +
 
 +
A good guide is [[Building Openmoko from scratch#Build host prerequisites|the section on build host prerequisites]] in [[Building Openmoko from scratch]]
 +
 
 +
If you forgot anything which OE needs itself, OE will tell you shortly after you start building, but it does not check build dependencies of Openmoko, so you either have to install them before starting or install them after the build failed. OpenEmbedded will continue where it stopped when you restart the build afterwards.
  
 
==== Package requirements by distribution ====
 
==== Package requirements by distribution ====
 +
Your distribution needs to provide these commands in order for OpenEmbedded to start building:
 +
subversion texi2html texinfo help2man
 +
 +
Openmoko needs the development packages (with header files, development libraries and tools) in order to finish building:
 +
 +
<pre>ncurses zlib (or libz) OpenSSL GTK++</pre>
 +
 +
Because there are bugs in the interaction of QEMU and GCC-4, you'll need a copy of gcc-3.x installed as well.
 +
 +
===== Debian / Ubuntu =====
 +
 +
<pre>sudo apt-get install subversion build-essential help2man diffstat texi2html texinfo cvs gawk zip unzip cogito bzip2
 +
sudo apt-get install libncurses5-dev zlib1g-dev libssl-dev libgtk2.0-dev
 +
# To prevent errors in host validation
 +
sudo apt-get install ca-certificates
 +
# For Openmoko 2007.2 using BitBake-1.8.8:
 +
sudo apt-get install python-pysqlite2 sqlite3 sqlite3-doc python-pysqlite2-dbg
 +
# For building faster
 +
sudo apt-get install quilt python-psyco ccache
 +
# For qemu, install a second compiler for bug avoidance; MokoMakefile knows to look for it.
 +
sudo apt-get install gcc-3.4 g++-3.4 libsdl1.2-dev lynx netpbm dosfstools
 +
 +
# On Ubuntu 8.04 and and Debian testing/unstable, the following was required instead of cogito
 +
sudo apt-get install git-core
 +
# Ubuntu links /bin/sh to /bin/dash, but some scripts fail because they use pushd and popd, which dash does not support
 +
sudo dpkg-reconfigure dash
 +
# Select No when it asks you to install dash as /bin/sh.
 +
 +
# This may be needed only for ASU
 +
sudo apt-get install libxtst-dev</pre>
 +
 
===== SuSE =====
 
===== SuSE =====
* 10.3: <code>gcc-c++ ncurses-devel zlib-devel libopenssl-devel gtk2-devel subversion</code> and [http://download.opensuse.org/repositories/devel:/tools:/scm/SUSE_Factory/repodata/repoview/Development.Tools.group.html monotone]
+
For building Openmoko on 10.3, you need
* 10.1 and 10.2: same packages as 10.3, but install <code>openssl-devel</code> instead of libopenssl-devel. Use monotone for [http://download.opensuse.org/repositories/devel:/tools:/scm/openSUSE_10.2/repodata/repoview/Development.Tools.group.html 10.2] or [http://download.opensuse.org/repositories/devel:/tools:/scm/SUSE_Linux_10.1/repodata/repoview/Development.Tools.group.html 10.1]
+
  
=== Installation ===
+
<pre>gcc-c++ ncurses-devel zlib-devel libopenssl-devel gtk2-devel subversion diffstat texinfo help2man</pre>
  
==== With Qemu ====
+
For MokoMakefile to not fail on compiling qemu-user, you need to use gcc33:
This is an easy and good way to install a local version of openmoko on your linux computer(ubuntu). This is mostly the fastest way to get things working (approximatly 15 min)
+
  
see [[MokoMakefile#QEMU]]
+
wget [http://download.opensuse.org/repositories/devel:/tools:/gcc/openSUSE_Factory/i586/{cpp,gcc}33-3.3.3-41.8.i586.rpm http://download.opensuse.org/repositories/devel:/tools:/gcc/openSUSE_Factory/i586/{cpp,gcc}33-3.3.3-41.8.i586.rpm]
 +
rpm -Uhv {cpp,gcc}33-3.3.3-41.8.i586.rpm
  
==== Manually ====
+
See also the [[Talk:MokoMakefile#Building_on_SuSE_Linux_10.3-AMD64|Talk page on Building on SuSE Linux 10.3-AMD64]]
Here are the steps to use it:
+
  
1 - Set up your build host is set up according to:
+
10.1 and 10.2: same packages as 10.3, but install <code>openssl-devel</code> instead of libopenssl-devel.
  http://www.openembedded.org/wiki/OEandYourDistro
+
A good guide is also the [[Building OpenMoko from scratch#Build host prerequisites|section on build host prerequisites]] in [[Building OpenMoko from scratch]]
+
  
In addition, you'll need help2man, you can install it with your distribution's tools for example:
+
===== Mandriva =====
  apt-get install help2man
+
  
If you forgot anything which OE needs, OE will tell you on first start.
+
<pre>urpmi git help2man diffstat texi2html texinfo</pre>
  
2 - Create your $OMDIR directory (note that you can change ~/moko to any directory you like):
+
(Tested with Mandriva 2009.0. <tt>kernel-desktop-devel</tt> of the current kernel is installed in advance, which installs compilers, binutils and many other general compilation tools.)
  mkdir ~/moko ; cd ~/moko
+
3 - Grab MokoMakefile:
+
  wget http://www.rwhitby.net/files/openmoko/Makefile
+
  
If that doesn't work, try
+
==== For all distributions ====
  
  wget http://svn.nslu2-linux.org/svnroot/mokomakefile/trunk/Makefile
+
As the QEMU-based neo1973 emulator is also built as part of the build process started by MokoMakefile, so you need gcc-3.3 and other packages for building QEMU installed. See [[Using QEMU with MokoMakefile#Build requirements|the build requirements section]] in [[Using QEMU with MokoMakefile]] for information on the required software.
  
  note: If you want to compile for the old version 2007.1 instead of the new
+
If you are having problems compiling QEMU and do not need it, you can disable building of QEMU by adding following line to build/conf/local.conf file:
        version edit the top of the Makefile. Edit the lines at the top to
+
        look like this:
+
            OPENMOKO_GENERATION = 2007.1
+
            #OPENMOKO_GENERATION = 2007.2
+
  
{{note|For building 2007.2, MokoMakefile uses BitBake 1.8.8 which requires python-sqlite2 and sqlite-3.3 or later. Users of SUSE Linux 10.1 can update to [http://download.opensuse.org/pub/opensuse/distribution/10.2/repo/oss/suse/i586/sqlite-3.3.8-14.i586.rpm the version of openSUSE 10.2]}}
+
<pre>ENABLE_BINARY_LOCALE_GENERATION = "0"</pre>
  
4 - Set up the environment:
+
===== Proxy =====
  make setup
+
5 - Start building. Before starting a lengthy make process, check in Tips section about how to make Make multicore aware. You may want to modify the build/conf/local.conf file for your target (emulation/chroot) environment:
+
  make openmoko-devel-image
+
  
This will set up the recommended directory structure as described in [[Building OpenMoko from scratch]], will download all the required software (from the right places with the right versions), and will immediately start building an image.
+
Users behind a proxy should ensure that their proxy is configured in their wgetrc file as the http_proxy environment variable is unset by MokoMakefile.
  
Once you have done this, you can choose to continue using the MokoMakefile to initiate your subsequent builds, or you can go into the build directory and run bitbake commands manually.  The choice is yours.
+
== Building Openmoko with MokoMakefile ==
  
===Updating the environment===  
+
=== Preparations ===
For easy maintenance of your build environment the following commands are available.
+
Create your ${OMDIR} directory (note that you can change ~/moko to any directory you like):
  
1 - To update the MokoMakefile to the latest version:
+
<pre>mkdir ~/moko ; cd ~/moko</pre>
  make update-makefile
+
  
2 - To make sure that any recent changes to the build directory structure have been applied:
+
If you have your ~/moko dir mounted from a different file system, be sure to edit /etc/mtab to add the 'exec' permission to the file system, else bitbake will fail with error messages stating that /usr/bin/env is an invalid interpreter.
  make setup
+
If you ever want to move your $OMDIR to another location, you must run
  
3 - To update the OpenMoko repository checkout and the MokoMakefile patches to the latest version:
+
<pre>make clobber ; make setup</pre>
  make update
+
  
A quick way to rebuild a new image with the latest updates:
+
to reinitialize the environment.  Yes, this will take a long time, so choose $OMDIR carefully.
  make update-makefile && make setup update openmoko-devel-image
+
  
===Reporting Problems===
+
=== MokoMakefile ===
  
First, make sure that the problem is reproducible after running
+
Grab MokoMakefile:
  
  make update-makefile && make setup && make update
+
  wget [http://downloads.freesmartphone.org/Makefile http://downloads.freesmartphone.org/Makefile]
  
then running
+
{{note|MokoMakefile uses BitBake 1.8.x which requires python-sqlite2 and sqlite-3.3 or later. Users of SUSE Linux 10.1 can update to [http://download.opensuse.org/pub/opensuse/distribution/10.2/repo/oss/suse/i586/sqlite-3.3.8-14.i586.rpm the version of openSUSE 10.2]}}
  
make clean-package-<foo>
+
=== Environment ===
  
(where you replace <foo> with the name of the package which is failing)
+
Set up the environment with:
  
then running
+
<pre>make setup</pre>
  
make openmoko-devel-image
+
=== Building ===
  
If you can get the error to occur three times in a row after running that sequence of commands (including the update and setup steps) three times, then feel free to report it to rwhitby in #openmoko on [http://wiki.openmoko.org/wiki/Development_resources#IRC IRC].
+
Before starting a lengthy make process, check the [[#Tips|Tips]] section below for how to make Make multicore aware. You may want to modify the build/conf/local.conf file for your target (emulation/chroot) environment.
  
===Known MokoMakefile errors===
+
<pre>make fso-gta02-testing-image</pre>
  
If you experience the following after changing from OM-2007.1 to OM-2007.2:
+
or
  
Patch bitbake-1.6.6-om3.patch does not apply (enforce with -f)
+
<pre>make fso-gta01-testing-image</pre>
  
then type "make clobber-patches" to fix it.  There was a period of 24 hours when there was a bug in the MokoMakefile which causes this problem.  Once the patches have been clobbered, they will re-download and the problem will not reoccur.
+
''Hint:'' The images build with this command can be found under ${OMDIR}/fso-testing/tmp/deploy/glibc/images/
  
===Work-arounds===
+
This will set up the recommended directory structure, will download all the required software (from the right places with the right versions), and will immediately start building an image.
  
Work-arounds for temporary or isolated problems should be added to the [[Talk:MokoMakefile|Discussion page]] which is associated with this pageAs they are fixed, they will be removed from that page.
+
Once you have done this, you can choose to continue using the MokoMakefile to initiate your subsequent builds, or you can go into the fso-testing directory and run bitbake commands manuallyThe choice is yours.
  
===Tips===
+
With luck - you should now have images in your ${OMDIR}/fso-testing/tmp/deploy/glibc/images/ directory. You can then [[Flashing the Neo FreeRunner|flash these]].
*You can reduce the amount of consumed disk space significantly by adding
+
  INHERIT += "rm_work"
+
in your local.conf (e.g. ~/moko/build/conf/local.conf). This will remove the contents of each build/tmp/work/*/<package> directory after the corresponding package builds correctly.
+
  
*If you an encounter an error with monotone similar to the following:
+
==Updating the environment==
  mtn: misuse: database /home/''username''/moko/OE.mtn is laid out according to an old schema
+
Then you need to upgrade OE.mtn  Use the following command while in ~/moko:
+
  # mtn --db OE.mtn db migrate
+
  
*If a certain package does not build due to corrupted download or some such try to remove the sources and rebuild it.
+
For easy maintenance of your build environment the following commands are available.
rm sources/<package>*
+
cd build
+
. ../setup-env
+
bitbake -crebuild <package>
+
after that your build might just work again.
+
  
*For people with multiple CPU's (or dual-core ones) this small patch might be useful to build things faster.
+
1 - To update the MokoMakefile to the latest version:
Edit the local.conf and add the following lines:
+
PARALLEL_MAKE = "-j 4"
+
BB_NUMBER_THREADS = "4"
+
  
Change the PARALLEL_MAKE and BB_NUMBER_THREADS values to something that suits better if it chokes your machine.
+
<pre>make update-common</pre>
  
*For amd64 host users you need the patch from http://bugs.openembedded.org/show_bug.cgi?id=1765 to build db3-native
+
Be aware that any changes you previously made to the Makefile are lost when executing ''update-makefile''.
  
* If you encounter an error related with the qemu-native package and not compiling for the qemu, you can edit the build/conf/local.conf file and add ENABLE_BINARY_LOCALE_GENERATION = "0" line to avoid the error.
+
2 - To make sure that any recent changes to the build directory structure have been applied:
  
* To prevent building tons of locales, add a line like this to local.conf:
+
<pre>make setup</pre>
GLIBC_GENERATE_LOCALES = "en_US.UTF-8 nl_NL.UTF-8"
+
  
* To not build any binary locales at all, add this to local.conf:
+
3 - To update the Openmoko repository checkouts and the MokoMakefile patches to the latest version:
ENABLE_BINARY_LOCALE_GENERATION = "0"
+
  
* If you want to rebuild the package indexes (for instance, after compiling a new version of a package) without building <code>openmoko-devel-image</code>, run <code>make build-package-package-index</code>.
+
<pre>make update</pre>
  
===Build and setup of qemu-neo1973 using the MokoMakefile===
+
A quick way to rebuild a new image with the latest updates:
The MokoMakefile has support for automatically building, flashing, and running [[OpenMoko under QEMU]] using qemu-neo1973, a fork of qemu which adds simulation of almost all [[Neo1973]] devices  in order allow testing OpenMoko images in a virtual environment.
+
  
==== Installation of qemu build requisites ====
+
<pre>make update-common && make setup update fso-gta02-testing-image</pre>
*gcc 3.4 or 3.3
+
*lynx
+
*netpbm
+
*SDL-devel
+
*mkdosfs (from dosfstools)
+
  
===== Debian 4.0 and Ubuntu 7.04 =====
+
==Build issues==
  sudo apt-get install gcc-3.4 lynx netpbm libsdl1.2-dev dosfstools
+
===== SUSE Linux / openSUSE =====
+
get gcc33 and cpp33 for SUSE Linux [http://download.opensuse.org/repositories/devel:/tools:/gcc/SUSE_Linux_10.1/repodata/ 10.1], openSUSE [http://download.opensuse.org/repositories/devel:/tools:/gcc/openSUSE_10.2/repodata/ 10.2] and openSUSE [http://download.opensuse.org/repositories/devel:/tools:/gcc/openSUSE_Factory/repodata/ Factory]
+
and install both rpms at once using:
+
rpm -Uhv cpp33-*.rpm gcc33-*.rpm
+
  
Install the packages <code>lynx</code>, <code>netbpm</code>, <code>SDL-devel</code> and <code>dosfstools</code> e.g. using <code>yast</code>, <code>apt</code>, or <code>smart</code>.
+
First, make sure that the problem is reproducible after running
  
On 10.1 and 10.2, apply the [[Talk:MokoMakefile#QEMU_build_fails_to_compile_USB_code|workaround for qemu-neu1973 USB compilation]].
+
<pre>make update-common && make setup && make update</pre>
  
===== Other distributions =====
+
If not, and you can get the error to occur three times in a row after running that sequence of commands (including the update and setup steps) three times, then feel free to report it in the Openmoko development Trac at https://docs.openmoko.org/trac/wiki/NewTicket or in #openmoko on [[Development_resources#IRC|IRC]]. If bitbake has started to run, then it's almost guaranteed that the problem is in the OE build recipes, *not* in the MokoMakefile itself (which is just a convenience wrapper around the OpenEmbedded build system).  Please do not report build recipe errors to the MokoMakefile author.
You need gcc-3.x for building qemu, if you have no precompiled gcc-3.x packages, instructions to build gcc-3.3.6 for building qemu are found here:
+
http://en.opensuse.org/Qemu_with_kqemu_kernel_module_support#GCC-3.3.6
+
  
===== Compilation and use =====
+
If you have chronic build problems, cleaning your environment variables and re-running the build from scratch may help. The following script should remove all non-essential variables; you should also manually trim your path to the minimum.
  
Create a new directory and download the Moko Makefile to it:
+
<pre>`env | grep -Ev '^(SHELL|TERM|OLDPWD|USER|USERNAME|PATH|EDITOR|LANG|HOME|DISPLAY|_)=' \
  mkdir openmoko
+
| sed 's/^\(.*\)=.*/unset \1/'`</pre>
  cd openmoko
+
  wget http://www.rwhitby.net/files/openmoko/Makefile
+
  
“'''make qemu'''” will build qemu-neo1973, download the latest official OpenMoko images, flash the images into the virtual NAND flash, create an empty virtual SD card, and run the emulator (you still need to install the makefile as mentioned above, however).
+
(you must include the backticks).
  
* <code>'''make run-qemu'''</code> - restarts qemu with the currently flashed OpenMoko images and current virtual SD card.
+
Note that on some boxes it is necessary to call "make" by typing "/usr/bin/make" afterwards.
* <code>'''make run-qemu-snapshot'''</code> - does the same but starts qemu with -snapshot which causes QEMU to write all changes to temporary files instead of flash and disk image files.<BR>This has the benefit that the virtual neu1973 is not changed, but that also all changes <code>make run-qemu-snapshot</code> in parallel without creating incoherent flash and SD card state as it would occur when one (or even more) instances would update disk or flash images while other instances do not expect this to happen underneath. You can however force the write back by pressing <code>C-a s</code> in the QEMU window which may be useful to update the flash and disk images in the last qemu instance which is running to preserve the changes, after all other instances are terminated.
+
  
You may also use:
+
On current Ubuntu/Debian unstable/testing boxes another trick is necessary. glibc_2.6.1 fails to build since it is unable to generate the necessary locales until you type in the following line:
* <code>'''make download-images'''</code> - to download the latest official images
+
* <code>'''make flash-qemu-official'''</code> - to flash those images
+
* <code>'''make flash-qemu-local'''</code> - to flash your latest locally built images, which can then be followed by
+
* <code>'''make qemu-copy-package-''foo'''''</code> - copies <code>''foo''.ipk</code> to the virtual SD card,  which allows you to use <code>ipkg install /media/mmcblk0/''file''</code> inside the running OpenMoko to install the package.
+
  
If you want to calibrate your screen,
+
<pre>sudo sysctl -w vm.mmap_min_addr=0</pre>
look at [http://onlinedev.blogspot.com/2007/08/calibrating-openmoko-v20072.html]
+
  
For detailed information on advanced usage of qemu-neo1973 see also: ''[[OpenMoko under QEMU]]''
+
Note that this temporarily disables a new security vulnerability check that has entered /etc/sysctrl - but that makes problems with loads of applications.
  
===Developing with MokoMakefile===
+
To re-enable this check do the following:
  
{{note|If using MokoMakefile with OM2007.2 then references to $OMDIR/openmoko should be replaced with $OMDIR/openembedded.  Also references to tmp/work/armv4t-linux should be replaced with tmp/work/fic-gta01-angstrom-linux-gnueabi}}
+
<pre>sudo sysctl -w vm.mmap_min_addr=65536</pre>
  
For the following explanations $OMDIR is the directory where there Makefile puts all the stuff.
+
See the talk page of this article for more details on this solution.
  
To make in-tree changes and have them built and used by qemu:
+
===Known MokoMakefile errors ===
  
  cd $OMDIR/openmoko
+
==== SVN Server Certificate Errors ====
  quilt new descriptive-patch-name.patch
+
  quilt add trunk/src/name-of-file-to-change # do this for every file you are about to modify
+
  ...make the changes...
+
  quilt refresh # this creates a file in $OMDIR/patches/openmoko-HEAD/ and updates the quilt series file there
+
  
Note: Do '''NOT''' use absolute paths as this confuses quilt and will get you a diff of the file against /dev/null!
+
If you get an error like the following:
  
To build the changes and have them used by qemu:
+
<pre>NOTE: Fetch svn://svn.projects.openmoko.org/svnroot/;module=assassin;proto=https
 +
Error validating server certificate for 'https://svn.projects.openmoko.org:443':
 +
- The certificate is not issued by a trusted authority. Use the
 +
fingerprint to validate the certificate manually!
 +
Certificate information:
 +
- Hostname: projects.openmoko.org
 +
- Valid: from Thu, 05 Jun 2008 01:02:42 GMT until Tue, 02 Dec 2008 01:02:42 GMT
 +
- Issuer: http://www.cacert.org, Root CA
 +
- Fingerprint: a5:7d:4e:37:e8:94:ee:ba:c1:e8:e9:4b:33:cb:34:91:a9:6d:d3:84
 +
(R)eject, accept (t)emporarily or accept (p)ermanently?
 +
svn: OPTIONS of 'https://svn.projects.openmoko.org/svnroot/assassin':
 +
Server certificate verification failed: issuer is not trusted (https://svn.projects.openmoko.org)</pre>
  
  make build-qemu
+
It means you haven't yet accepted the server certificate for the SVN server.  To remedy this, execute the following commands, and hit "p" (to permanently accept the certificate) when prompted:
  make flash-qemu-local
+
  make run-qemu
+
  
If you want to modify applications instead of the openmoko toolchain, this is what you have to do (example: openmoko-messages):
+
<pre>cd /tmp
 +
svn co https://svn.projects.openmoko.org/svnroot/assassin
 +
rm -rf assassin
 +
cd -</pre>
  
  cd $OMDIR/build
+
==== exposure_svn and Subversion 1.5.0 ====
  . ../setup-env
+
  bitbake -c unpack openmoko-messages
+
  cd ../build/tmp/work/armv4t-linux/openmoko-messages-0.0.1+svnnow-r2_2276/openmoko-messages/
+
  ...make the changes...
+
  cd -
+
  bitbake openmoko-messages
+
  
Then continue with MokoMakefile usage.
+
If you get an error like this:
  
If you want to add an application to your openmoko distribution, do this:
+
<code>"NameError: global name 'log' is not defined"</code>
All file edits should be done using quilt as described above. That way a patch can easily be submitted to the openmoko project.
+
First, create a directory that will correspond to your package and edit a '''.bb''' file in there:
+
  cd $OMDIR/openmoko/
+
  quilt new mycoolpackage.patch
+
  mkdir trunk/oe/packages/mycoolpackage
+
  quilt add trunk/oe/packages/mycoolpackage/mycoolpackage_1.bb
+
  quilt edit trunk/oe/packages/mycoolpackage/mycoolpackage_1.bb
+
  
The file should have the following content:
+
There's a bug with subversion 1.5.0 -- downgrade to 1.4.x (or check out the latest subversion sources and use those as they're fixed) and re-fetch the sources.
  DESCRIPTION = "This is a cool package"
+
  SECTION = "username/mycoolpackage"
+
  PV = "1"
+
 
+
  inherit autotools
+
 
+
  SRC_URI = "http://www.example.com/download/mycoolpackage-1.tar.gz"
+
  
Explanation:
+
=== Fixes for distribution/environment-specific or isolated issues ===
* DESCRIPTION - Just a short text explaining the package
+
* SECTION - I have no clue, but I'll use username/mycoolpackage for now
+
* PV - Package Version
+
* inherit autotools - The package can be compiled by './configure && make && make install' so we tell MokoMakefile to do it this way.
+
* SRC_URI = ... - This is the download location of the package source. It's imperative that the tar.gz contains a directory called '''packagename-packageversion''' (in this case: mycoolpackage-1) so that MokoMakefile can find it automatically or the build will fail.
+
  
This is not all. We also need to tell MokoMakfile that it needs to build and include the package in the image. To do this, do
+
Work-arounds for temporary or isolated problems can be found and should be added to the [[Talk:MokoMakefile|Discussion page]] which is associated with this page. As they are fixed, they will be removed from that page.
  $OMDIR/openmoko# quilt edit trunk/oe/packages/tasks/task-openmoko.bb
+
Here, increase the value '''PR''' by one and add '''mycoolpackage \''' (with the backslash!) just before the line reading '''#  update-alternatives \'''.
+
  
Now run
+
==Tips==
  quilt refresh
+
  cd ..
+
  make update openmoko-devel-image
+
  
And if everything's alright you should now have an OpenMoko image to flash to your phone or run in qemu as described above.
+
* Make sure umask is set to 0022 before you run "make setup"
 +
* If a certain package does not build due to corrupted download or some such try to remove the sources and rebuild it.
 +
<pre>rm sources/<package>*
 +
cd fso-testing
 +
. ./setup-env
 +
bitbake -crebuild <package></pre>
 +
After that your build might just work again.
  
=== Hello World application ===
+
* For people with multiple CPU's (or dual-core ones) this small patch might be useful to build things faster.
 +
Edit the local.conf and add the following lines:
 +
<pre>PARALLEL_MAKE = "-j 4"
 +
BB_NUMBER_THREADS = "4"</pre>
  
There is a [http://wiki.openmoko.org/wiki/Building_a_hello_world_application Hello World!] tutorial available too.
+
Change the PARALLEL_MAKE and BB_NUMBER_THREADS values to something that suits better if it chokes your machine.
  
===Testimonials===
+
* I have some problem with the parallel building, mkfs.jffs failed to build the image because the directory was modify while the building of the fs. [[User:Patrick.hetu|patrick.hetu]] 02:19, 27 May 2008 (UTC)
MokoMakefile is recommended by 4 out of 4 new developers on #openmoko, with testimonials such as "For some reason last night I couldn't get my manual install of everything to work (bb complained about my bbpath I think) ... but with your makefile, it works great!", "MokoMakefile rocks!", and "Wow this build system is nice - it just seems more polished than my gumstix toolchain buildroot system".
+
  
Project page:
+
* If you encounter an error related with the qemu-native package and not compiling for the qemu, you can edit the build/conf/local.conf file and add ENABLE_BINARY_LOCALE_GENERATION = "0" line to avoid the error.
http://mokomakefile.projects.openmoko.org/
+
  
{{Languages|MokoMakefile}}
+
* To prevent building tons of locales, add a line like this to local.conf:
 +
<pre>GLIBC_GENERATE_LOCALES = "en_US.UTF-8 nl_NL.UTF-8"</pre>
 +
 
 +
* To not build any binary locales at all, add this to local.conf:
 +
<pre>ENABLE_BINARY_LOCALE_GENERATION = "0"</pre>
 +
 
 +
* If you want to rebuild the package indexes (for instance, after compiling a new version of a package) without building the whole <code>image</code>, run <code>make build-package-package-index</code>.
 +
 
 +
[[User:Wurp]] will update this to be a little more comprehensible, but maybe it can help someone as-is in the meantime:
 +
* If MokoMakefile always fails on some fetch in zlib, just find the binary somewhere, add it to the downloads or sources directory manually (create the .md5 matching file if necessary), and retry.
 +
 
 +
* Make sure you do not have . in your PATH, this causes an "unrecognized option -Qy" error when building g++spec
 +
 
 +
=== Useful commands ===
 +
 
 +
Here is the list (not complete) of useful MokoMakefile commands (actually make targets) and a short description of each one. These should be run inside $OMDIR directory.
 +
 
 +
; make fso-gta02-testing-image : build the full development image
 +
 
 +
; make fso-gta02-unstable-image : build the unstable bleeding edge image (it often will not build or run)
 +
 
 +
; make update-common : updates MokoMakefile
 +
 
 +
; make setup : to make sure that any recent changes to the build directory structure have been applied
 +
 
 +
; make update : to update the Openmoko repository checkout and the MokoMakefile patches to the latest version
 +
 
 +
== Developing with MokoMakefile ==
 +
 
 +
You are not advised to use MokoMakefile for application development.  Openmoko distributes a stand-alone toolchain for that purpose.
 +
 
 +
== Testimonials ==
 +
 
 +
MokoMakefile is recommended by 4 out of 4 new developers on #openmoko, with testimonials such as "For some reason last night I couldn't get my manual install of everything to work (bb complained about my bbpath I think) ... but with your makefile, it works great!", "MokoMakefile rocks!", "Wow this build system is nice - it just seems more polished than my gumstix toolchain buildroot system", "make openmoko-devel-image :) - no magic there", and "I have never been able to get a build to complete in the pure OE environment, whereas Mokomakefile for some reason builds fine."
 +
 
 +
Project page:
 +
*http://mokomakefile.projects.openmoko.org/
  
[[Category:Developer]]
+
[[Category:Developer resources]]
[[Category:Guides]]
+

Latest revision as of 20:27, 3 September 2009


NOTE: According to the source repository for MokoMakefile, this tool is obsolete. See Toolchain on how to develop for Openmoko.

MokoMakefile is a Makefile which saves lots of work when setting up an Openmoko build environment. By automating the setup process of a new Openmoko build environment, it provides an environment which is configured the same for all the existing developers and should therefore be preferred over manual procedures or individual setup procedures. It brings the same repeatability to build environment creation and maintenance as that which the BitBake scripts bring to OpenEmbedded ease and standardize the process of building OpenEmbedded.

MokoMakefile does not install anything into your system (it can and should be started as normal user). MokoMakefile is a wrapper around all that is required to make it easy to set up and maintain a development environment that fully complies with the setup instructions published by Openmoko.

MokoMakefile is developed by Rod Whitby - it is not an official product of Openmoko (although I would be happy for them to pick it up and use it internally). If there is any discrepancy between the Openmoko build instructions, and the operation of the MokoMakefile, then you should consider the official instructions to be correct.

The MokoMakefile is able to build the stable, testing and unstable versions of the FSO distribution images.

MokoMakefile no longer builds the QEMU-based Neo1973 emulator.

Contents

[edit] Requirements for building Openmoko

Independent on whether MokoMakefile or a manual process is used to setup an Openmoko build environment, there are several requirements which must be fulfilled in order for the Openmoko build to succeed:

  • RAM: The build host needs to have at least 512MB of RAM, and about the same amount of swap. Some packages built by OpenEmbedded like busybox are built by compiling all source files into one binary which causes gcc to grow beyond 300MB of size and no part of this memory may be on swap for the compile to finish in predictable time. For busybox, this can be turned off, but turning this off means that busybox will not as well optimized by gcc.
  • Disk space: You need about 12 GB of available disk space for the Openmoko build to succeed (see below for a tip on how to reduce this).
  • Time: The initial build takes at least 5 hours (on 2GHz core2duo without multiprocessor optimization) and may take several days on slower machines.

[edit] Required software

Some distribution specific hints on preparing your build host for building OpenEmbedded are on http://wiki.openembedded.net/index.php/OEandYourDistro but they may be outdated, incomplete and do not cover everything which Openmoko needs to build.

A good guide is the section on build host prerequisites in Building Openmoko from scratch

If you forgot anything which OE needs itself, OE will tell you shortly after you start building, but it does not check build dependencies of Openmoko, so you either have to install them before starting or install them after the build failed. OpenEmbedded will continue where it stopped when you restart the build afterwards.

[edit] Package requirements by distribution

Your distribution needs to provide these commands in order for OpenEmbedded to start building: subversion texi2html texinfo help2man

Openmoko needs the development packages (with header files, development libraries and tools) in order to finish building:

ncurses zlib (or libz) OpenSSL GTK++

Because there are bugs in the interaction of QEMU and GCC-4, you'll need a copy of gcc-3.x installed as well.

[edit] Debian / Ubuntu
sudo apt-get install subversion build-essential help2man diffstat texi2html texinfo cvs gawk zip unzip cogito bzip2
sudo apt-get install libncurses5-dev zlib1g-dev libssl-dev libgtk2.0-dev
# To prevent errors in host validation
sudo apt-get install ca-certificates
# For Openmoko 2007.2 using BitBake-1.8.8:
sudo apt-get install python-pysqlite2 sqlite3 sqlite3-doc python-pysqlite2-dbg
# For building faster
sudo apt-get install quilt python-psyco ccache
# For qemu, install a second compiler for bug avoidance; MokoMakefile knows to look for it.
sudo apt-get install gcc-3.4 g++-3.4 libsdl1.2-dev lynx netpbm dosfstools

# On Ubuntu 8.04 and and Debian testing/unstable, the following was required instead of cogito
sudo apt-get install git-core
# Ubuntu links /bin/sh to /bin/dash, but some scripts fail because they use pushd and popd, which dash does not support
sudo dpkg-reconfigure dash
# Select No when it asks you to install dash as /bin/sh.

# This may be needed only for ASU
sudo apt-get install libxtst-dev
[edit] SuSE

For building Openmoko on 10.3, you need

gcc-c++ ncurses-devel zlib-devel libopenssl-devel gtk2-devel subversion diffstat texinfo help2man

For MokoMakefile to not fail on compiling qemu-user, you need to use gcc33:

wget http://download.opensuse.org/repositories/devel:/tools:/gcc/openSUSE_Factory/i586/{cpp,gcc}33-3.3.3-41.8.i586.rpm
rpm -Uhv {cpp,gcc}33-3.3.3-41.8.i586.rpm

See also the Talk page on Building on SuSE Linux 10.3-AMD64

10.1 and 10.2: same packages as 10.3, but install openssl-devel instead of libopenssl-devel.

[edit] Mandriva
urpmi git help2man diffstat texi2html texinfo

(Tested with Mandriva 2009.0. kernel-desktop-devel of the current kernel is installed in advance, which installs compilers, binutils and many other general compilation tools.)

[edit] For all distributions

As the QEMU-based neo1973 emulator is also built as part of the build process started by MokoMakefile, so you need gcc-3.3 and other packages for building QEMU installed. See the build requirements section in Using QEMU with MokoMakefile for information on the required software.

If you are having problems compiling QEMU and do not need it, you can disable building of QEMU by adding following line to build/conf/local.conf file:

ENABLE_BINARY_LOCALE_GENERATION = "0"
[edit] Proxy

Users behind a proxy should ensure that their proxy is configured in their wgetrc file as the http_proxy environment variable is unset by MokoMakefile.

[edit] Building Openmoko with MokoMakefile

[edit] Preparations

Create your ${OMDIR} directory (note that you can change ~/moko to any directory you like):

mkdir ~/moko ; cd ~/moko

If you have your ~/moko dir mounted from a different file system, be sure to edit /etc/mtab to add the 'exec' permission to the file system, else bitbake will fail with error messages stating that /usr/bin/env is an invalid interpreter. If you ever want to move your $OMDIR to another location, you must run

make clobber ; make setup

to reinitialize the environment. Yes, this will take a long time, so choose $OMDIR carefully.

[edit] MokoMakefile

Grab MokoMakefile:

wget http://downloads.freesmartphone.org/Makefile
NOTE: MokoMakefile uses BitBake 1.8.x which requires python-sqlite2 and sqlite-3.3 or later. Users of SUSE Linux 10.1 can update to the version of openSUSE 10.2


[edit] Environment

Set up the environment with:

make setup

[edit] Building

Before starting a lengthy make process, check the Tips section below for how to make Make multicore aware. You may want to modify the build/conf/local.conf file for your target (emulation/chroot) environment.

make fso-gta02-testing-image

or

make fso-gta01-testing-image

Hint: The images build with this command can be found under ${OMDIR}/fso-testing/tmp/deploy/glibc/images/

This will set up the recommended directory structure, will download all the required software (from the right places with the right versions), and will immediately start building an image.

Once you have done this, you can choose to continue using the MokoMakefile to initiate your subsequent builds, or you can go into the fso-testing directory and run bitbake commands manually. The choice is yours.

With luck - you should now have images in your ${OMDIR}/fso-testing/tmp/deploy/glibc/images/ directory. You can then flash these.

[edit] Updating the environment

For easy maintenance of your build environment the following commands are available.

1 - To update the MokoMakefile to the latest version:

make update-common

Be aware that any changes you previously made to the Makefile are lost when executing update-makefile.

2 - To make sure that any recent changes to the build directory structure have been applied:

make setup

3 - To update the Openmoko repository checkouts and the MokoMakefile patches to the latest version:

make update

A quick way to rebuild a new image with the latest updates:

make update-common && make setup update fso-gta02-testing-image

[edit] Build issues

First, make sure that the problem is reproducible after running

make update-common && make setup && make update

If not, and you can get the error to occur three times in a row after running that sequence of commands (including the update and setup steps) three times, then feel free to report it in the Openmoko development Trac at https://docs.openmoko.org/trac/wiki/NewTicket or in #openmoko on IRC. If bitbake has started to run, then it's almost guaranteed that the problem is in the OE build recipes, *not* in the MokoMakefile itself (which is just a convenience wrapper around the OpenEmbedded build system). Please do not report build recipe errors to the MokoMakefile author.

If you have chronic build problems, cleaning your environment variables and re-running the build from scratch may help. The following script should remove all non-essential variables; you should also manually trim your path to the minimum.

`env | grep -Ev '^(SHELL|TERM|OLDPWD|USER|USERNAME|PATH|EDITOR|LANG|HOME|DISPLAY|_)=' \
| sed 's/^\(.*\)=.*/unset \1/'`

(you must include the backticks).

Note that on some boxes it is necessary to call "make" by typing "/usr/bin/make" afterwards.

On current Ubuntu/Debian unstable/testing boxes another trick is necessary. glibc_2.6.1 fails to build since it is unable to generate the necessary locales until you type in the following line:

sudo sysctl -w vm.mmap_min_addr=0

Note that this temporarily disables a new security vulnerability check that has entered /etc/sysctrl - but that makes problems with loads of applications.

To re-enable this check do the following:

sudo sysctl -w vm.mmap_min_addr=65536

See the talk page of this article for more details on this solution.

[edit] Known MokoMakefile errors

[edit] SVN Server Certificate Errors

If you get an error like the following:

NOTE: Fetch svn://svn.projects.openmoko.org/svnroot/;module=assassin;proto=https
Error validating server certificate for 'https://svn.projects.openmoko.org:443':
- The certificate is not issued by a trusted authority. Use the
fingerprint to validate the certificate manually!
Certificate information:
- Hostname: projects.openmoko.org
- Valid: from Thu, 05 Jun 2008 01:02:42 GMT until Tue, 02 Dec 2008 01:02:42 GMT
- Issuer: http://www.cacert.org, Root CA
- Fingerprint: a5:7d:4e:37:e8:94:ee:ba:c1:e8:e9:4b:33:cb:34:91:a9:6d:d3:84
(R)eject, accept (t)emporarily or accept (p)ermanently?
svn: OPTIONS of 'https://svn.projects.openmoko.org/svnroot/assassin':
Server certificate verification failed: issuer is not trusted (https://svn.projects.openmoko.org)

It means you haven't yet accepted the server certificate for the SVN server. To remedy this, execute the following commands, and hit "p" (to permanently accept the certificate) when prompted:

cd /tmp
svn co https://svn.projects.openmoko.org/svnroot/assassin
rm -rf assassin
cd -

[edit] exposure_svn and Subversion 1.5.0

If you get an error like this:

"NameError: global name 'log' is not defined"

There's a bug with subversion 1.5.0 -- downgrade to 1.4.x (or check out the latest subversion sources and use those as they're fixed) and re-fetch the sources.

[edit] Fixes for distribution/environment-specific or isolated issues

Work-arounds for temporary or isolated problems can be found and should be added to the Discussion page which is associated with this page. As they are fixed, they will be removed from that page.

[edit] Tips

  • Make sure umask is set to 0022 before you run "make setup"
  • If a certain package does not build due to corrupted download or some such try to remove the sources and rebuild it.
rm sources/<package>*
cd fso-testing
. ./setup-env
bitbake -crebuild <package>

After that your build might just work again.

  • For people with multiple CPU's (or dual-core ones) this small patch might be useful to build things faster.

Edit the local.conf and add the following lines:

PARALLEL_MAKE = "-j 4"
BB_NUMBER_THREADS = "4"

Change the PARALLEL_MAKE and BB_NUMBER_THREADS values to something that suits better if it chokes your machine.

  • I have some problem with the parallel building, mkfs.jffs failed to build the image because the directory was modify while the building of the fs. patrick.hetu 02:19, 27 May 2008 (UTC)
  • If you encounter an error related with the qemu-native package and not compiling for the qemu, you can edit the build/conf/local.conf file and add ENABLE_BINARY_LOCALE_GENERATION = "0" line to avoid the error.
  • To prevent building tons of locales, add a line like this to local.conf:
GLIBC_GENERATE_LOCALES = "en_US.UTF-8 nl_NL.UTF-8"
  • To not build any binary locales at all, add this to local.conf:
ENABLE_BINARY_LOCALE_GENERATION = "0"
  • If you want to rebuild the package indexes (for instance, after compiling a new version of a package) without building the whole image, run make build-package-package-index.

User:Wurp will update this to be a little more comprehensible, but maybe it can help someone as-is in the meantime:

  • If MokoMakefile always fails on some fetch in zlib, just find the binary somewhere, add it to the downloads or sources directory manually (create the .md5 matching file if necessary), and retry.
  • Make sure you do not have . in your PATH, this causes an "unrecognized option -Qy" error when building g++spec

[edit] Useful commands

Here is the list (not complete) of useful MokoMakefile commands (actually make targets) and a short description of each one. These should be run inside $OMDIR directory.

make fso-gta02-testing-image 
build the full development image
make fso-gta02-unstable-image 
build the unstable bleeding edge image (it often will not build or run)
make update-common 
updates MokoMakefile
make setup 
to make sure that any recent changes to the build directory structure have been applied
make update 
to update the Openmoko repository checkout and the MokoMakefile patches to the latest version

[edit] Developing with MokoMakefile

You are not advised to use MokoMakefile for application development. Openmoko distributes a stand-alone toolchain for that purpose.

[edit] Testimonials

MokoMakefile is recommended by 4 out of 4 new developers on #openmoko, with testimonials such as "For some reason last night I couldn't get my manual install of everything to work (bb complained about my bbpath I think) ... but with your makefile, it works great!", "MokoMakefile rocks!", "Wow this build system is nice - it just seems more polished than my gumstix toolchain buildroot system", "make openmoko-devel-image :) - no magic there", and "I have never been able to get a build to complete in the pure OE environment, whereas Mokomakefile for some reason builds fine."

Project page:

Personal tools

MokoMakefile

MokoMakefile is a simple Makefile which saves lots of work when setting up an OpenMoko build environment. By automating the setup process of a new OpenMoko build environment, it provides an environment which is configured the same for all the existing developers and should therefore be preferred over manual procedures or individual setup procedures.

It brings the same repeatability to build environment creation and maintenance as that which the BitBake scripts bring to OpenEmbedded ease and standardize the process of building OpenEmbedded.

Unlike the manual process described at Building OpenMoko from scratch, MokoMakefile does not install anything into your system (it can and should be started as normal user).

MokoMakefile is a wrapper around all that to make it easy to set up and maintain a development environment that fully complies with the setup instructions published by OpenMoko.

MokoMakefile is developed by Rod Whitby - it is not an official product of OpenMoko (although I would be happy for them to pick it up and use it internally). If there is any discrepancy between the official OpenMoko build instructions, and the operation of the MokoMakefile, then you should consider the official instructions to be correct.

The MokoMakefile is able to build either OM-2007.1 or OM-2007.2 images. The core team chooses the default, but you can select one or the other at the top of the Makefile.

Requirements for building OpenMoko

Independent on whether MokoMakefile or a manual process is used to setup an OpenMoko build environment, there are several requirements which must be fullfilled in order for the OpenMoko build to succeed:

  • RAM: The build host needs to have at least 512MB of RAM, and about the same amount of swap. Some packages built by OpenEmbedded like busybox are built by compiling all source files into one binary which causes gcc to grow belond 300MB of size and no part of this memory may be on swap for the compile to finish in predictable time. For busybox, this can be turned off, but turning this off means that busybox will not as well optimized by gcc.
  • Disk space: You need about 12 GB of available disk space for the OpenMoko build to succeed (see below for a tip on how to reduce this).
  • Software: gcc, gcc-c++, subversion and monotone and more (see below for distribution-specific hints)
  • Time: The initial build takes at least 5 hours (on 2GHz core2duo without multiprocessor optimization) and may take to several days on slower machines.

Package requirements by distribution

SuSE
  • 10.3: gcc-c++ ncurses-devel zlib-devel libopenssl-devel gtk2-devel subversion and monotone
  • 10.1 and 10.2: same packages as 10.3, but install openssl-devel instead of libopenssl-devel. Use monotone for 10.2 or 10.1

Installation

With Qemu

This is an easy and good way to install a local version of openmoko on your linux computer(ubuntu). This is mostly the fastest way to get things working (approximatly 15 min)

see MokoMakefile#QEMU

Manually

Here are the steps to use it:

1 - Set up your build host is set up according to:

  http://www.openembedded.org/wiki/OEandYourDistro

A good guide is also the section on build host prerequisites in Building OpenMoko from scratch

In addition, you'll need help2man, you can install it with your distribution's tools for example:

 apt-get install help2man

If you forgot anything which OE needs, OE will tell you on first start.

2 - Create your $OMDIR directory (note that you can change ~/moko to any directory you like):

  mkdir ~/moko ; cd ~/moko

3 - Grab MokoMakefile:

  wget http://www.rwhitby.net/files/openmoko/Makefile

If that doesn't work, try

  wget http://svn.nslu2-linux.org/svnroot/mokomakefile/trunk/Makefile
  note: If you want to compile for the old version 2007.1 instead of the new
        version edit the top of the Makefile. Edit the lines at the top to 
        look like this:
            OPENMOKO_GENERATION = 2007.1
            #OPENMOKO_GENERATION = 2007.2
NOTE: For building 2007.2, MokoMakefile uses BitBake 1.8.8 which requires python-sqlite2 and sqlite-3.3 or later. Users of SUSE Linux 10.1 can update to the version of openSUSE 10.2


4 - Set up the environment:

  make setup

5 - Start building. Before starting a lengthy make process, check in Tips section about how to make Make multicore aware. You may want to modify the build/conf/local.conf file for your target (emulation/chroot) environment:

  make openmoko-devel-image

This will set up the recommended directory structure as described in Building OpenMoko from scratch, will download all the required software (from the right places with the right versions), and will immediately start building an image.

Once you have done this, you can choose to continue using the MokoMakefile to initiate your subsequent builds, or you can go into the build directory and run bitbake commands manually. The choice is yours.

Updating the environment

For easy maintenance of your build environment the following commands are available.

1 - To update the MokoMakefile to the latest version:

  make update-makefile 

2 - To make sure that any recent changes to the build directory structure have been applied:

  make setup 

3 - To update the OpenMoko repository checkout and the MokoMakefile patches to the latest version:

  make update

A quick way to rebuild a new image with the latest updates:

  make update-makefile && make setup update openmoko-devel-image

Reporting Problems

First, make sure that the problem is reproducible after running

make update-makefile && make setup && make update

then running

make clean-package-<foo>

(where you replace <foo> with the name of the package which is failing)

then running

make openmoko-devel-image

If you can get the error to occur three times in a row after running that sequence of commands (including the update and setup steps) three times, then feel free to report it to rwhitby in #openmoko on IRC.

Known MokoMakefile errors

If you experience the following after changing from OM-2007.1 to OM-2007.2:

Patch bitbake-1.6.6-om3.patch does not apply (enforce with -f)

then type "make clobber-patches" to fix it. There was a period of 24 hours when there was a bug in the MokoMakefile which causes this problem. Once the patches have been clobbered, they will re-download and the problem will not reoccur.

Work-arounds

Work-arounds for temporary or isolated problems should be added to the Discussion page which is associated with this page. As they are fixed, they will be removed from that page.

Tips

  • You can reduce the amount of consumed disk space significantly by adding
  INHERIT += "rm_work"

in your local.conf (e.g. ~/moko/build/conf/local.conf). This will remove the contents of each build/tmp/work/*/<package> directory after the corresponding package builds correctly.

  • If you an encounter an error with monotone similar to the following:
  mtn: misuse: database /home/username/moko/OE.mtn is laid out according to an old schema

Then you need to upgrade OE.mtn Use the following command while in ~/moko:

  # mtn --db OE.mtn db migrate
  • If a certain package does not build due to corrupted download or some such try to remove the sources and rebuild it.
rm sources/<package>*
cd build
. ../setup-env
bitbake -crebuild <package>

after that your build might just work again.

  • For people with multiple CPU's (or dual-core ones) this small patch might be useful to build things faster.

Edit the local.conf and add the following lines:

PARALLEL_MAKE = "-j 4"
BB_NUMBER_THREADS = "4"

Change the PARALLEL_MAKE and BB_NUMBER_THREADS values to something that suits better if it chokes your machine.

  • If you encounter an error related with the qemu-native package and not compiling for the qemu, you can edit the build/conf/local.conf file and add ENABLE_BINARY_LOCALE_GENERATION = "0" line to avoid the error.
  • To prevent building tons of locales, add a line like this to local.conf:
GLIBC_GENERATE_LOCALES = "en_US.UTF-8 nl_NL.UTF-8"
  • To not build any binary locales at all, add this to local.conf:
ENABLE_BINARY_LOCALE_GENERATION = "0"
  • If you want to rebuild the package indexes (for instance, after compiling a new version of a package) without building openmoko-devel-image, run make build-package-package-index.

Build and setup of qemu-neo1973 using the MokoMakefile

The MokoMakefile has support for automatically building, flashing, and running OpenMoko under QEMU using qemu-neo1973, a fork of qemu which adds simulation of almost all Neo1973 devices in order allow testing OpenMoko images in a virtual environment.

Installation of qemu build requisites

  • gcc 3.4 or 3.3
  • lynx
  • netpbm
  • SDL-devel
  • mkdosfs (from dosfstools)
Debian 4.0 and Ubuntu 7.04
 sudo apt-get install gcc-3.4 lynx netpbm libsdl1.2-dev dosfstools
SUSE Linux / openSUSE

get gcc33 and cpp33 for SUSE Linux 10.1, openSUSE 10.2 and openSUSE Factory and install both rpms at once using:

rpm -Uhv cpp33-*.rpm gcc33-*.rpm

Install the packages lynx, netbpm, SDL-devel and dosfstools e.g. using yast, apt, or smart.

On 10.1 and 10.2, apply the workaround for qemu-neu1973 USB compilation.

Other distributions

You need gcc-3.x for building qemu, if you have no precompiled gcc-3.x packages, instructions to build gcc-3.3.6 for building qemu are found here: http://en.opensuse.org/Qemu_with_kqemu_kernel_module_support#GCC-3.3.6

Compilation and use

Create a new directory and download the Moko Makefile to it:

 mkdir openmoko
 cd openmoko
 wget http://www.rwhitby.net/files/openmoko/Makefile

make qemu” will build qemu-neo1973, download the latest official OpenMoko images, flash the images into the virtual NAND flash, create an empty virtual SD card, and run the emulator (you still need to install the makefile as mentioned above, however).

  • make run-qemu - restarts qemu with the currently flashed OpenMoko images and current virtual SD card.
  • make run-qemu-snapshot - does the same but starts qemu with -snapshot which causes QEMU to write all changes to temporary files instead of flash and disk image files.
    This has the benefit that the virtual neu1973 is not changed, but that also all changes make run-qemu-snapshot in parallel without creating incoherent flash and SD card state as it would occur when one (or even more) instances would update disk or flash images while other instances do not expect this to happen underneath. You can however force the write back by pressing C-a s in the QEMU window which may be useful to update the flash and disk images in the last qemu instance which is running to preserve the changes, after all other instances are terminated.

You may also use:

  • make download-images - to download the latest official images
  • make flash-qemu-official - to flash those images
  • make flash-qemu-local - to flash your latest locally built images, which can then be followed by
  • make qemu-copy-package-foo - copies foo.ipk to the virtual SD card, which allows you to use ipkg install /media/mmcblk0/file inside the running OpenMoko to install the package.

If you want to calibrate your screen, look at [1]

For detailed information on advanced usage of qemu-neo1973 see also: OpenMoko under QEMU

Developing with MokoMakefile

NOTE: If using MokoMakefile with OM2007.2 then references to $OMDIR/openmoko should be replaced with $OMDIR/openembedded. Also references to tmp/work/armv4t-linux should be replaced with tmp/work/fic-gta01-angstrom-linux-gnueabi


For the following explanations $OMDIR is the directory where there Makefile puts all the stuff.

To make in-tree changes and have them built and used by qemu:

 cd $OMDIR/openmoko
 quilt new descriptive-patch-name.patch
 quilt add trunk/src/name-of-file-to-change # do this for every file you are about to modify
 ...make the changes...
 quilt refresh # this creates a file in $OMDIR/patches/openmoko-HEAD/ and updates the quilt series file there

Note: Do NOT use absolute paths as this confuses quilt and will get you a diff of the file against /dev/null!

To build the changes and have them used by qemu:

 make build-qemu
 make flash-qemu-local
 make run-qemu

If you want to modify applications instead of the openmoko toolchain, this is what you have to do (example: openmoko-messages):

 cd $OMDIR/build
 . ../setup-env
 bitbake -c unpack openmoko-messages
 cd ../build/tmp/work/armv4t-linux/openmoko-messages-0.0.1+svnnow-r2_2276/openmoko-messages/
 ...make the changes...
 cd -
 bitbake openmoko-messages

Then continue with MokoMakefile usage.

If you want to add an application to your openmoko distribution, do this: All file edits should be done using quilt as described above. That way a patch can easily be submitted to the openmoko project. First, create a directory that will correspond to your package and edit a .bb file in there:

 cd $OMDIR/openmoko/
 quilt new mycoolpackage.patch
 mkdir trunk/oe/packages/mycoolpackage
 quilt add trunk/oe/packages/mycoolpackage/mycoolpackage_1.bb
 quilt edit trunk/oe/packages/mycoolpackage/mycoolpackage_1.bb

The file should have the following content:

 DESCRIPTION = "This is a cool package"
 SECTION = "username/mycoolpackage"
 PV = "1"
 
 inherit autotools
 
 SRC_URI = "http://www.example.com/download/mycoolpackage-1.tar.gz"

Explanation:

  • DESCRIPTION - Just a short text explaining the package
  • SECTION - I have no clue, but I'll use username/mycoolpackage for now
  • PV - Package Version
  • inherit autotools - The package can be compiled by './configure && make && make install' so we tell MokoMakefile to do it this way.
  • SRC_URI = ... - This is the download location of the package source. It's imperative that the tar.gz contains a directory called packagename-packageversion (in this case: mycoolpackage-1) so that MokoMakefile can find it automatically or the build will fail.

This is not all. We also need to tell MokoMakfile that it needs to build and include the package in the image. To do this, do

 $OMDIR/openmoko# quilt edit trunk/oe/packages/tasks/task-openmoko.bb

Here, increase the value PR by one and add mycoolpackage \ (with the backslash!) just before the line reading # update-alternatives \.

Now run

 quilt refresh
 cd ..
 make update openmoko-devel-image

And if everything's alright you should now have an OpenMoko image to flash to your phone or run in qemu as described above.

Hello World application

There is a Hello World! tutorial available too.

Testimonials

MokoMakefile is recommended by 4 out of 4 new developers on #openmoko, with testimonials such as "For some reason last night I couldn't get my manual install of everything to work (bb complained about my bbpath I think) ... but with your makefile, it works great!", "MokoMakefile rocks!", and "Wow this build system is nice - it just seems more polished than my gumstix toolchain buildroot system".

Project page: http://mokomakefile.projects.openmoko.org/