blob: 85a687e592cf96484f6a33fab8be80af5e4cb9f6 [file] [log] [blame]
Dan Pasanen03447712016-12-19 11:22:55 -06001LineageOS
Steve Kondike5f263c2010-07-11 00:17:02 -04002===========
Chris Soyars5c513762010-07-05 03:40:52 +00003
Steve Kondike5f263c2010-07-11 00:17:02 -04004Submitting Patches
5------------------
Dan Pasanen03447712016-12-19 11:22:55 -06006Patches are always welcome! Please submit your patches via LineageOS Gerrit!
Wes Garnera8c03cc2011-01-16 03:07:26 -06007You can do this by using these commands:
Chris Soyars5c513762010-07-05 03:40:52 +00008
Wes Garnera8c03cc2011-01-16 03:07:26 -06009 (From root android directory)
10 . build/envsetup.sh
11 (Go to repo you are patching, make your changes and commit)
Luca Stefani5c60e4f2017-08-17 19:28:48 +020012 lineagegerrit <for(new)/changes(patch set)> <branch/change-id>
Steve Kondike5f263c2010-07-11 00:17:02 -040013
Luca Stefani5c60e4f2017-08-17 19:28:48 +020014 repo start lineage-15.0 .
Wes Garnera8c03cc2011-01-16 03:07:26 -060015 (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 Pasanen03447712016-12-19 11:22:55 -060023To view the status of your and others' patches, visit [LineageOS Code Review](http://review.lineageos.org/)
Wes Garnera8c03cc2011-01-16 03:07:26 -060024
Steve Kondike5f263c2010-07-11 00:17:02 -040025
26Getting Started
27---------------
28
Dan Pasanen03447712016-12-19 11:22:55 -060029To get started with Android/LineageOS, you'll need to get
ciwrla57590d2013-01-14 21:57:39 -080030familiar with [Repo](https://source.android.com/source/using-repo.html) and [Version Control with Git](https://source.android.com/source/version-control.html).
Steve Kondike5f263c2010-07-11 00:17:02 -040031
Dan Pasanen03447712016-12-19 11:22:55 -060032To initialize your local repository using the LineageOS trees, use a command like this:
Steve Kondike5f263c2010-07-11 00:17:02 -040033
Luca Stefani5c60e4f2017-08-17 19:28:48 +020034 repo init -u git://github.com/LineageOS/android.git -b lineage-15.0
Steve Kondike5f263c2010-07-11 00:17:02 -040035
36Then to sync up:
37
38 repo sync
39
Dan Pasanen03447712016-12-19 11:22:55 -060040Please see the [LineageOS Wiki](http://wiki.lineageos.org/) for building instructions, by device.
Steve Kondike5f263c2010-07-11 00:17:02 -040041
42For more information on this Github Organization and how it is structured,
Dan Pasanen03447712016-12-19 11:22:55 -060043please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization)
Steve Kondike5f263c2010-07-11 00:17:02 -040044
45Buildbot
46--------
47
48All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
49
Dan Pasanen03447712016-12-19 11:22:55 -060050You can view the current build statuses in the [Jenkins](http://jenkins.lineageos.org) tool.