1 page.title=Downloading the Source 2 @jd:body 3 4 <!-- 5 Copyright 2014 The Android Open Source Project 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 --> 19 <div id="qv-wrapper"> 20 <div id="qv"> 21 <h2>In this document</h2> 22 <ol id="auto-toc"> 23 </ol> 24 </div> 25 </div> 26 27 <p> 28 The Android source tree is located in a Git repository hosted by Google. The Git repository 29 includes metadata for the Android source, including those related to changes to the source 30 and the date they were made. This document describes how to download the source tree for a 31 specific Android code-line. 32 </p> 33 <h2 id="installing-repo"> 34 Installing Repo 35 </h2> 36 <p> 37 Repo is a tool that makes it easier to work with Git in the context of Android. For more 38 information about Repo, see the <a href="developing.html">Developing</a> section. 39 </p> 40 <p> 41 To install Repo: 42 </p> 43 <ol> 44 <li> 45 <p> 46 Make sure you have a bin/ directory in your home directory and that it is included in 47 your path: 48 </p> 49 <pre> 50 <code>$ mkdir ~/bin 51 $ PATH=~/bin:$PATH 52 </code> 53 </pre> 54 </li> 55 <li> 56 <p> 57 Download the Repo tool and ensure that it is executable: 58 </p> 59 <pre> 60 $ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo 61 $ chmod a+x ~/bin/repo 62 </pre> 63 </li> 64 </ol> 65 <p> 66 For version 1.17, the SHA-1 checksum for repo is ddd79b6d5a7807e911b524cb223bc3544b661c28 67 </p> 68 <p> 69 For version 1.19, the SHA-1 checksum for repo is 92cbad8c880f697b58ed83e348d06619f8098e6c 70 </p> 71 <p> 72 For version 1.20, the SHA-1 checksum for repo is e197cb48ff4ddda4d11f23940d316e323b29671c 73 </p> 74 <p> 75 For version 1.21, the SHA-1 checksum for repo is b8bd1804f432ecf1bab730949c82b93b0fc5fede 76 </p> 77 <p> 78 For version 1.22, the SHA-1 checksum for repo is da0514e484f74648a890c0467d61ca415379f791 79 </p> 80 <h2 id="initializing-a-repo-client"> 81 Initializing a Repo client 82 </h2> 83 <p> 84 After installing Repo, set up your client to access the Android source repository: 85 </p> 86 <ol> 87 <li> 88 <p> 89 Create an empty directory to hold your working files. If you're using MacOS, this has to 90 be on a case-sensitive filesystem. Give it any name you like: 91 </p> 92 <pre> 93 $ mkdir WORKING_DIRECTORY 94 $ cd WORKING_DIRECTORY 95 </pre> 96 </li> 97 <li> 98 <p> 99 Configure git with your real name and email address. To use the Gerrit code-review tool, 100 you will need an email address that is connected with a <a href= 101 "https://www.google.com/accounts">registered Google account</a>. Make sure this is a live 102 address at which you can receive messages. The name that you provide here will show up in 103 attributions for your code submissions. 104 </p> 105 <pre> 106 $ git config --global user.name "Your Name" 107 $ git config --global user.email "you (a] example.com" 108 </pre> 109 </li> 110 </li> 111 <li> 112 <p> 113 Run <code>repo init</code> to bring down the latest version of Repo with all its most 114 recent bug fixes. You must specify a URL for the manifest, which specifies where the 115 various repositories included in the Android source will be placed within your working 116 directory. 117 </p> 118 <pre> 119 $ repo init -u https://android.googlesource.com/platform/manifest 120 </pre> 121 <p> 122 To check out a branch other than "master", specify it with <code>-b</code>. For a list of branches, see <a href="build-numbers.html#source-code-tags-and-builds">Source Code Tags and Builds</a>. 123 </p> 124 <pre> 125 $ repo init -u https://android.googlesource.com/platform/manifest -b android-4.0.1_r1 126 </pre> 127 </li> 128 </ol> 129 <p> 130 A successful initialization will end with a message stating that Repo is initialized in your 131 working directory. Your client directory should now contain a <code>.repo</code> directory 132 where files such as the manifest will be kept. 133 </p> 134 <h2 id="getting-the-files"> 135 Downloading the Android Source Tree 136 </h2> 137 <p> 138 To pull down the Android source tree to your working directory from the repositories as 139 specified in the default manifest, run 140 </p> 141 <pre>$ repo sync</pre> 142 <p> 143 The Android source files will be located in your working directory under their project names. 144 The initial sync operation will take an hour or more to complete. For more about <code>repo 145 sync</code> and other Repo commands, see the <a href="developing.html">Developing</a> section. 146 </p> 147 <h2 id="using-authentication"> 148 Using Authentication 149 </h2> 150 <p> 151 By default, access to the Android source code is anonymous. To protect the servers against 152 excessive usage, each IP address is associated with a quota. 153 </p> 154 <p> 155 When sharing an IP address with other users (e.g. when accessing the source repositories from 156 beyond a NAT firewall), the quotas can trigger even for regular usage patterns (e.g. if many 157 users sync new clients from the same IP address within a short period). 158 </p> 159 <p> 160 In that case, it is possible to use authenticated access, which then uses a separate quota 161 for each user, regardless of the IP address. 162 </p> 163 <p> 164 The first step is to create a password with <a href= 165 "https://android.googlesource.com/new-password">the password generator</a> 166 and follow the instructions on the password generator page. 167 </p> 168 <p> 169 The second step is to force authenticated access, by using the following manifest URI: 170 <code>https://android.googlesource.com/a/platform/manifest</code>. Notice how the 171 <code>/a/</code> directory prefix triggers mandatory authentication. You can convert an 172 existing client to use mandatory authentication with the following command: 173 </p> 174 <pre> 175 $ repo init -u https://android.googlesource.com/a/platform/manifest 176 </pre> 177 <h2 id="troubleshooting-network-issues"> 178 Troubleshooting network issues 179 </h2> 180 <p> 181 When downloading from behind a proxy (which is common in some corporate environments), it 182 might be necessary to explicitly specify the proxy that is then used by repo: 183 </p> 184 <pre> 185 $ export HTTP_PROXY=http://<proxy_user_id>:<proxy_password>@<proxy_server>:<proxy_port>; 186 $ export HTTPS_PROXY=http://<proxy_user_id>:<proxy_password>@<proxy_server>:<proxy_port>; 187 </pre> 188 <p> 189 More rarely, Linux clients experience connectivity issues, getting stuck in the middle of 190 downloads (typically during "Receiving objects"). It has been reported that tweaking the 191 settings of the TCP/IP stack and using non-parallel commands can improve the situation. You 192 need root access to modify the TCP setting: 193 </p> 194 <pre> 195 $ sudo sysctl -w net.ipv4.tcp_window_scaling=0 196 $ repo sync -j1 197 </pre> 198 <h2 id="using-a-local-mirror"> 199 Using a local mirror 200 </h2> 201 <p> 202 When using several clients, especially in situations where bandwidth is scarce, it is better 203 to create a local mirror of the entire server content, and to sync clients from that mirror 204 (which requires no network access). The download for a full mirror is smaller than the 205 download of two clients, while containing more information. 206 </p> 207 <p> 208 These instructions assume that the mirror is created in <code>/usr/local/aosp/mirror</code>. 209 The first step is to create and sync the mirror itself. Notice the <code>--mirror</code> flag, which 210 can be specified only when creating a new client: 211 </p> 212 <pre> 213 $ mkdir -p /usr/local/aosp/mirror 214 $ cd /usr/local/aosp/mirror 215 $ repo init -u https://android.googlesource.com/mirror/manifest --mirror 216 $ repo sync 217 </pre> 218 <p> 219 Once the mirror is synced, new clients can be created from it. Note that it's important to 220 specify an absolute path: 221 </p> 222 <pre>$ mkdir -p /usr/local/aosp/master 223 $ cd /usr/local/aosp/master 224 $ repo init -u /usr/local/aosp/mirror/platform/manifest.git 225 $ repo sync 226 </pre> 227 <p> 228 Finally, to sync a client against the server, the mirror needs to be synced against the 229 server, then the client against the mirror: 230 </p> 231 <pre> 232 $ cd /usr/local/aosp/mirror 233 $ repo sync 234 $ cd /usr/local/aosp/master 235 $ repo sync 236 </pre> 237 <p> 238 It's possible to store the mirror on a LAN server and to access it over NFS, SSH or Git. It's 239 also possible to store it on a removable drive and to pass that drive around between users or 240 between machines. 241 </p> 242 <h2 id="verifying-git-tags"> 243 Verifying Git Tags 244 </h2> 245 <p> 246 Load the following public key into your GnuPG key database. The key is used to sign annotated 247 tags that represent releases. 248 </p> 249 <pre> 250 $ gpg --import 251 </pre> 252 <p> 253 Copy and paste the key(s) below, then enter EOF (Ctrl-D) to end the input and process the 254 keys. 255 </p> 256 <pre> 257 -----BEGIN PGP PUBLIC KEY BLOCK----- 258 Version: GnuPG v1.4.2.2 (GNU/Linux) 259 260 mQGiBEnnWD4RBACt9/h4v9xnnGDou13y3dvOx6/t43LPPIxeJ8eX9WB+8LLuROSV 261 lFhpHawsVAcFlmi7f7jdSRF+OvtZL9ShPKdLfwBJMNkU66/TZmPewS4m782ndtw7 262 8tR1cXb197Ob8kOfQB3A9yk2XZ4ei4ZC3i6wVdqHLRxABdncwu5hOF9KXwCgkxMD 263 u4PVgChaAJzTYJ1EG+UYBIUEAJmfearb0qRAN7dEoff0FeXsEaUA6U90sEoVks0Z 264 wNj96SA8BL+a1OoEUUfpMhiHyLuQSftxisJxTh+2QclzDviDyaTrkANjdYY7p2cq 265 /HMdOY7LJlHaqtXmZxXjjtw5Uc2QG8UY8aziU3IE9nTjSwCXeJnuyvoizl9/I1S5 266 jU5SA/9WwIps4SC84ielIXiGWEqq6i6/sk4I9q1YemZF2XVVKnmI1F4iCMtNKsR4 267 MGSa1gA8s4iQbsKNWPgp7M3a51JCVCu6l/8zTpA+uUGapw4tWCp4o0dpIvDPBEa9 268 b/aF/ygcR8mh5hgUfpF9IpXdknOsbKCvM9lSSfRciETykZc4wrRCVGhlIEFuZHJv 269 aWQgT3BlbiBTb3VyY2UgUHJvamVjdCA8aW5pdGlhbC1jb250cmlidXRpb25AYW5k 270 cm9pZC5jb20+iGAEExECACAFAknnWD4CGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIX 271 gAAKCRDorT+BmrEOeNr+AJ42Xy6tEW7r3KzrJxnRX8mij9z8tgCdFfQYiHpYngkI 272 2t09Ed+9Bm4gmEO5Ag0ESedYRBAIAKVW1JcMBWvV/0Bo9WiByJ9WJ5swMN36/vAl 273 QN4mWRhfzDOk/Rosdb0csAO/l8Kz0gKQPOfObtyYjvI8JMC3rmi+LIvSUT9806Up 274 hisyEmmHv6U8gUb/xHLIanXGxwhYzjgeuAXVCsv+EvoPIHbY4L/KvP5x+oCJIDbk 275 C2b1TvVk9PryzmE4BPIQL/NtgR1oLWm/uWR9zRUFtBnE411aMAN3qnAHBBMZzKMX 276 LWBGWE0znfRrnczI5p49i2YZJAjyX1P2WzmScK49CV82dzLo71MnrF6fj+Udtb5+ 277 OgTg7Cow+8PRaTkJEW5Y2JIZpnRUq0CYxAmHYX79EMKHDSThf/8AAwUIAJPWsB/M 278 pK+KMs/s3r6nJrnYLTfdZhtmQXimpoDMJg1zxmL8UfNUKiQZ6esoAWtDgpqt7Y7s 279 KZ8laHRARonte394hidZzM5nb6hQvpPjt2OlPRsyqVxw4c/KsjADtAuKW9/d8phb 280 N8bTyOJo856qg4oOEzKG9eeF7oaZTYBy33BTL0408sEBxiMior6b8LrZrAhkqDjA 281 vUXRwm/fFKgpsOysxC6xi553CxBUCH2omNV6Ka1LNMwzSp9ILz8jEGqmUtkBszwo 282 G1S8fXgE0Lq3cdDM/GJ4QXP/p6LiwNF99faDMTV3+2SAOGvytOX6KjKVzKOSsfJQ 283 hN0DlsIw8hqJc0WISQQYEQIACQUCSedYRAIbDAAKCRDorT+BmrEOeCUOAJ9qmR0l 284 EXzeoxcdoafxqf6gZlJZlACgkWF7wi2YLW3Oa+jv2QSTlrx4KLM= 285 =Wi5D 286 -----END PGP PUBLIC KEY BLOCK----- 287 </pre> 288 <p> 289 After importing the keys, you can verify any tag with 290 </p> 291 <pre> 292 $ git tag -v TAG_NAME 293 </pre> 294 <p> 295 If you haven't <a href="initializing.html#ccache">set up ccache</a> yet, now would be a good 296 time to do it. 297 </p> 298
