README.md
1Android PGO Profiles
2====================
3
4For the latest version of this doc, please make sure to visit:
5[Android PGO Profiles](https://android.googlesource.com/toolchain/pgo-profiles/+/master/README.md)
6
7
8Getting the necessary dependencies
9----------------------------------
10
11First, you need to install `python-pip`, as well as 2 packages from it.
12
13```
14$ sudo apt-get install python-pip
15$ sudo pip install --upgrade google-api-python-client
16$ sudo pip install --upgrade oauth2client
17```
18
19Updating PGO Profiles
20---------------------
21
22We only update profiles in the Android release branch, so this script should
23be run directly from that location. The following is a sample command line for
24updating the PGO profiles:
25
26```
27$ python toolchain/pgo-profiles/scripts/update_profiles.py -b <BUG_NUMBER> --add-do-not-merge <BUILD_ID> ALL --profdata-suffix <YYYY-MM-DD>
28$ repo upload --cbr toolchain/pgo-profiles/
29# Each separate profile will be uploaded as a single patch, so that it can get appropriate reviews.
30```
31
32Note that you need to change that command to supply 3 pieces of information:
33- `BUG_NUMBER`: The buganizer bug number that should be part of the commit
34 message. For Android R, that bug number is 150254950.
35- `BUILD_ID`: The build id from which to extract the PGO profiles. You should
36 check [go/ab](http://go/ab) for the given release branch.
37- `YYYY-MM-DD`: The date of the build that the profiles come from (to keep it
38 easier to check for stale profiles).
39
40
41More Information
42----------------
43
44PGO-related questions should be sent to the Android LLVM team's public list:
45[android-llvm@googlegroups.com](https://groups.google.com/forum/#!forum/android-llvm)
46
47