blob: 26b3de3bd87049c266327c591f899b6cb930cf01 [file] [log] [blame]
Dan Pasanen3a38b892016-12-19 12:18:38 -06001Lineage
Chris Soyars878bc022011-11-14 21:41:03 -05002===========
3
4Submitting Patches
5------------------
Dan Pasanen3a38b892016-12-19 12:18:38 -06006Patches are always welcome! Please submit your patches via Lineage Gerrit!
Chris Soyars878bc022011-11-14 21:41:03 -05007You can do this by using these commands:
8
9 (From root android directory)
10 . build/envsetup.sh
11 (Go to repo you are patching, make your changes and commit)
12 cmgerrit <for(new)/changes(patch set)> <branch/change-id>
13
Trafalgar Squareda596442016-10-26 06:41:17 +020014 repo start cm-14.1 .
Chris Soyars878bc022011-11-14 21:41:03 -050015 (Make your changes and commit)
16 repo upload .
17Note: "." meaning current directory
18For more help on using this tool, use this command: repo help upload
19
20Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel)
21Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
22
Dan Pasanen3a38b892016-12-19 12:18:38 -060023To view the status of your and others' patches, visit [Lineage Code Review](http://review.lineageos.org/)
Chris Soyars878bc022011-11-14 21:41:03 -050024
25
26Getting Started
27---------------
28
Dan Pasanen3a38b892016-12-19 12:18:38 -060029To get started with Android/Lineage, you'll need to get
Kevin Cernekee4efef8e2013-06-02 13:30:09 -070030familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
Chris Soyars878bc022011-11-14 21:41:03 -050031
Dan Pasanen3a38b892016-12-19 12:18:38 -060032To initialize your local repository using the Lineage trees, use a command like this:
Chris Soyars878bc022011-11-14 21:41:03 -050033
Dan Pasanen3a38b892016-12-19 12:18:38 -060034 repo init -u git://github.com/LineageOS/android.git -b cm-14.1
Chris Soyars878bc022011-11-14 21:41:03 -050035
36Then to sync up:
37
38 repo sync
39
Dan Pasanen3a38b892016-12-19 12:18:38 -060040Please see the [Lineage Wiki](http://wiki.lineageos.org/) for building instructions.
Chris Soyars878bc022011-11-14 21:41:03 -050041
42For more information on this Github Organization and how it is structured,
Dan Pasanen3a38b892016-12-19 12:18:38 -060043please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization)
Chris Soyars878bc022011-11-14 21:41:03 -050044
45Buildbot
46--------
47
48All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
49
Dan Pasanen3a38b892016-12-19 12:18:38 -060050You can view the current build statuses at [Lineage Jenkins](http://jenkins.lineageos.org/)