1<!-- 2 Copyright 2010 The Android Open Source Project 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15--> 16 17# Initializing a Build Environment # 18 19The "Getting Started" section describes how to set up your local work environment, how to use Repo to get the Android files, and how to build the files on your machine. To build the Android source files, you will need to use Linux or Mac OS. Building under Windows is not currently supported. 20 21*Note: The source is approximately 2.6GB in size. You will need 10GB free to complete the build.* 22 23For an overview of the entire code-review and code-update process, see [Life of a Patch](life-of-a-patch.html). 24 25To see snapshots and histories of the files available in the public Android repositories, visit the [GitWeb](http://android.git.kernel.org) web interface. 26 27 28 29# Setting up a Linux build environment # 30 31The Android build is routinely tested in house on recent versions of Ubuntu (10.04 and later), but most distributions should have the required build tools available. Reports of successes or failures on other distributions are welcome. 32 33*Note: It is also possible to build Android in a virtual machine. If you are running Linux in a virtual machine, you will need at least 8GB of RAM/swap and 12GB or more of disk space in order to build the Android tree.* 34 35In general you will need: 36 37 - Python 2.4 -- 2.7, which you can download from [python.org](http://www.python.org/download/). 38 39 - JDK 6 if you wish to build Gingerbread or newer; JDK 5 for Froyo or older. You can download both from [java.sun.com](http://java.sun.com/javase/downloads/). 40 41 - Git 1.5.4 or newer. You can find it at [git-scm.com](http://git-scm.com/download). 42 43 - (optional) Valgrind, a tool that will help you find memory leaks, stack corruption, array bounds overflows, etc. Download from [valgrind.org](http://valgrind.org/downloads/current.html). 44 45Detailed instructions for Ubuntu 10.04+ follow. 46 47## Installing the JDK ## 48 49The Sun JDK is no longer in Ubuntu's main package repository. In order to download it, you need to add the appropriate repository and indicate to the system which JDK should be used. 50 51Java 6: for Gingerbread and newer 52 53 $ sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner" 54 $ sudo add-apt-repository "deb-src http://archive.canonical.com/ubuntu lucid partner" 55 $ sudo apt-get update 56 $ sudo apt-get install sun-java6-jdk 57 58Java 5: for Froyo and older 59 60 $ sudo add-apt-repository "deb http://archive.ubuntu.com/ubuntu hardy main multiverse" 61 $ sudo add-apt-repository "deb http://archive.ubuntu.com/ubuntu hardy-updates main multiverse" 62 $ sudo apt-get update 63 $ sudo apt-get install sun-java5-jdk 64 65## Installing required packages ## 66 67To set up your development environment, install the following required packages: 68 69 $ sudo apt-get install git-core gnupg flex bison gperf build-essential \ 70 zip curl zlib1g-dev libc6-dev lib32ncurses5-dev ia32-libs \ 71 x11proto-core-dev libx11-dev lib32readline5-dev lib32z-dev \ 72 libgl1-mesa-dev g++-multilib mingw32 tofrodos python-markdown \ 73 libxml2-utils 74 75## Configuring USB Access ## 76 77Under GNU/linux systems (and specifically under Ubuntu systems), 78regular users can't directly access USB devices by default. The 79system needs to be configured to allow such access. 80 81The recommended approach is to create a file 82`/etc/udev/rules.d/51-android.rules` (as the root user) and to copy 83the following lines in it. <username> must be replaced by the 84actual username of the user who is authorized to access the phones 85over USB. 86 87 # adb protocol on passion (Nexus One) 88 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e12", MODE="0600", OWNER="<username>" 89 # fastboot protocol on passion (Nexus One) 90 SUBSYSTEM=="usb", ATTR{idVendor}=="0bb4", ATTR{idProduct}=="0fff", MODE="0600", OWNER="<username>" 91 # adb protocol on crespo/crespo4g (Nexus S) 92 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e22", MODE="0600", OWNER="<username>" 93 # fastboot protocol on crespo/crespo4g (Nexus S) 94 SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", ATTR{idProduct}=="4e20", MODE="0600", OWNER="<username>" 95 96Those new rules take effect the next time a device is plugged in. 97It might therefore be necessary to unplug the device and plug it 98back into the computer. 99 100This is known to work on both Ubuntu Hardy Heron (8.04.x LTS) and 101Lucid Lynx (10.04.x LTS). Other versions of Ubuntu or other 102variants of GNU/linux might require different configurations. 103 104 105# Setting up a Mac OS X build environment # 106 107To build the Android files in a Mac OS environment, you need an Intel/x86 machine running MacOS 10.4 (Tiger), 10.5 (Leopard), or 10.6 (Snow Leopard). The Android build system and tools do not support the obsolete PowerPC architecture. 108 109Android must be built on a case-sensitive file system because the sources contain files that differ only in case. We recommend that you build Android on a partition that has been formatted with the journaled file system HFS+. HFS+ is required to successfully build Mac OS applications such as the Android Emulator for OS X. 110 111## Creating a case sensitive disk image ## 112 113If you want to avoid partitioning/formatting your hard drive, you can use 114a case-sensitive disk image instead. To create the image, launch Disk 115Utility and select "New Image". A size of 12GB is the minimum to 116complete the build, larger numbers are more future-proof. Using sparse images 117saves space while allowing to grow later as the need arises. Be sure to select 118"case sensitive, journaled" as the volume format. 119 120You can also create it from a shell with the following command: 121 122 # hdiutil create -type SPARSE -fs 'Case-sensitive Journaled HFS+' -size 40g ~/android.dmg 123 124This will create a .dmg file which, once mounted, acts as a drive with the required formatting for Android development. For a disk image named "android.dmg" stored in your home directory, you can add the following to your `~/.bash_profile` to mount the image when you execute "mountAndroid": 125 126 # mount the android file image 127 function mountAndroid { hdiutil attach ~/android.dmg -mountpoint /Volumes/android; } 128 129Once mounted, you'll do all your work in the "android" volume. You can eject it (unmount it) just like you would with an external drive. 130 131## Installing required packages ## 132 133- Install XCode from [the Apple developer site](http://developer.apple.com/). We recommend version 3.0 or newer. If you are not already registered as an Apple developer, you will have to create an Apple ID in order to download. 134 135- Install MacPorts from [macports.org](http://www.macports.org/install.php). 136 137 *Note: Make sure that `/opt/local/bin` appears in your path BEFORE `/usr/bin`. If not, add* 138 139 export PATH=/opt/local/bin:$PATH 140 141 *to your `~/.bash_profile`.* 142 143- Get make, git, and GPG packages from MacPorts: 144 145 $ POSIXLY_CORRECT=1 sudo port install gmake libsdl git-core gnupg 146 147 If using Mac OS 10.4, also install bison: 148 149 $ POSIXLY_CORRECT=1 sudo port install bison 150 151## Reverting from make 3.82 ## 152 153There is a bug in gmake 3.82 that prevents android from building. You can install version 3.81 using MacPorts by taking the following steps: 154 155- Edit `/opt/local/etc/macports/sources.conf` and add a line that says 156 157 file:///Users/Shared/dports 158 159 above the rsync line. Then create this directory: 160 161 $ mkdir /Users/Shared/dports 162 163- In the new `dports` directory, run 164 165 $ svn co --revision 50980 http://svn.macports.org/repository/macports/trunk/dports/devel/gmake/ devel/gmake/ 166 167- Create a port index for your new local repository: 168 169 $ portindex /Users/Shared/dports 170 171- Finally, install the old version of gmake with 172 173 $ sudo port install gmake @3.81 174 175## Setting a file descriptor limit ## 176 177On MacOS the default limit on the number of simultaneous file descriptors open is too low and a highly parallel build process may exceed this limit. 178 179To increase the cap, add the following lines to your `~/.bash_profile`: 180 181 # set the number of open files to be 1024 182 ulimit -S -n 1024 183 184# Next: Download the source # 185 186Your build environment is good to go! Proceed to [downloading the source](downloading.html).... 187