| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 1 | LineageOS |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 2 | =========== |
| 3 | |
| 4 | Submitting Patches |
| 5 | ------------------ |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 6 | Patches are always welcome! Please submit your patches via LineageOS Gerrit! |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 7 | You 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 Square | da59644 | 2016-10-26 06:41:17 +0200 | [diff] [blame] | 14 | repo start cm-14.1 . |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 15 | (Make your changes and commit) |
| 16 | repo upload . |
| 17 | Note: "." meaning current directory |
| 18 | For more help on using this tool, use this command: repo help upload |
| 19 | |
| 20 | Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel) |
| 21 | Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits> |
| 22 | |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 23 | To view the status of your and others' patches, visit [LineageOS Code Review](http://review.lineageos.org/) |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 24 | |
| 25 | |
| 26 | Getting Started |
| 27 | --------------- |
| 28 | |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 29 | To get started with Android/LineageOS, you'll need to get |
| Kevin Cernekee | 4efef8e | 2013-06-02 13:30:09 -0700 | [diff] [blame] | 30 | familiar with [Git and Repo](http://source.android.com/source/using-repo.html). |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 31 | |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 32 | To initialize your local repository using the LineageOS trees, use a command like this: |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 33 | |
| Dan Pasanen | 3a38b89 | 2016-12-19 12:18:38 -0600 | [diff] [blame] | 34 | repo init -u git://github.com/LineageOS/android.git -b cm-14.1 |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 35 | |
| 36 | Then to sync up: |
| 37 | |
| 38 | repo sync |
| 39 | |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 40 | Please see the [LineageOS Wiki](http://wiki.lineageos.org/) for building instructions. |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 41 | |
| 42 | For more information on this Github Organization and how it is structured, |
| Dan Pasanen | 3a38b89 | 2016-12-19 12:18:38 -0600 | [diff] [blame] | 43 | please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization) |
| Chris Soyars | 878bc02 | 2011-11-14 21:41:03 -0500 | [diff] [blame] | 44 | |
| 45 | Buildbot |
| 46 | -------- |
| 47 | |
| 48 | All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable. |
| 49 | |
| Dan Pasanen | 48d5ebd | 2016-12-26 23:21:25 -0600 | [diff] [blame] | 50 | You can view the current build statuses at [LineageOS Jenkins](http://jenkins.lineageos.org/) |