How to submit a patch
If you haven’t yet successfully downloaded the source and generated a build of LineageOS, make sure you are familiar with those steps. Information on doing a build is available in the build guide for your device.
Now make sure your local git username matches with your Gerrit username:
git config --global review.review.lineageos.org.username "gerrit username"
If you already have SSH keys set up (e.g. for GitHub), skip the following two steps.
Generate the SSH keys,:
ssh-keygen -t rsa -C "firstname.lastname@example.org"
Add the keys to the ssh-agent:
eval `ssh-agent -s` ssh-add ~/.ssh/id_rsa ssh-add
After that, copy/paste the content of
~/.ssh/id_rsa.pub to your Gerrit SSH Settings under Settings -> SSH Public Keys.
The steps above have to be performed only once.
Preparing the build environment
Go to the root of the source code:
Setup your build environment:
The rest of this guide will rely on this being done. You can check the proper execution of the commands by typing:
Your shell will then navigate to the root of the sources,
~/android/lineage or give an error.
Submitting to Gerrit
Uploading your changes
First, you need to start a topic branch. This branch holds the changes you make to the files on your computer that you will ultimately send to the LineageOS’ Gerrit instance for review. Create your topic branch:
repo start <branch name> <project path>
<branch name>in the
<project path>project. Replace
<project path>with the path of your target repository instead.
Change to the project (directory) that contains the file(s) you want to edit:
Do all the changes you need.
repo start, otherwise your changes will happen on a different branch and will not be tracked correctly.
After you make your changes, you can commit them just as you normally would:
git add <file you edited> git commit
Alternatively you can run
git add . to stage all changes.
Now you can upload your changes to Gerrit:
repo upload .
repo upload <project path>.
That’s it! Your change will be reviewed and may be accepted or rejected. See #Example_cases below for an example.
Submitting patch sets
It can happen that your submitted patch has issues or errors, which are noted in the code review, so you will want to resolve them. Sometimes it’s just tabs instead of spaces or typos in strings and variable names. To avoid some formal mistakes, make sure you’re familiar with the Android code style. For Eclipse users, just follow the instructions in
Before you edit those files, make sure you are on the correct branch:
If you are not or in no branch at all, switch to the correct branch:
git checkout [branchname]
Now you can edit the files you want. After that, do the usual
git status and notice that
git diff will only show you the changes you just made.
Make sure you add the files that you’ve modified by using
git add. Once you’re satisfied, prepare the upload, by amending your commit:
git commit --amend
This will open an editor with your initial commit message. You can change the commit message if you want to, but make sure the line starting with Change-Id remains unchanged as it contains the initial change ID. With this id, Gerrit will detect your upload as a patch set and not as a new patch.
You can do
git log and
git status again. Notice how git handles your initial commit and the amended commit as one single patch. As for
git show, it shows you all the changes made on that commit.
Finally, you can submit your patch set to your initial patch by typing:
repo upload .
Let’s say you want to make a change in
InputDevice.java that resides in the
frameworks/base project, and upload that to Gerrit for review. Start a local branch of that repo (directory) and call it
cd frameworks/base repo start mychanges .
Make the edits to that file. You can check those changes:
git add InputDevice.java -n
If the results are acceptable, stage the modified file:
git add InputDevice.java
Then commit it:
git commit -m 'Added feature xyz'
Issue the upload:
repo upload .
You should be asked a few questions and your commit should then be uploaded to Gerrit for review.
Add AWEXT Support
Start the new branch:
cd external/wpa_supplicant repo start mychanges-wpa_supplicant .
Make changes, edit a few files, add new drivers.. etc.
git add . git commit -m 'Added AWEXT drivers' repo upload .
 If you get a “Permission denied (publickey)” error and you’re sure that everything is right, try using a DSA key instead of RSA.
ssh-keygen -t dsa -C "email@example.com"
Getting your submission reviewed/merged
All submitted patches go through a code review process prior to being merged. In addition to peer reviews, certain project members have the capability to merge your changes into LineageOS. To make sure they get informed:
1) Add reviewers:
- For device/kernel repos, add the maintainer of your device
- For changes to various special projects (like this wiki), see the maintainers listed here. Note that the wiki editors can be added directly by typing “Wiki Editors” into the reviewer field
- For all other repos, add the Trusted Reviewers or Committers
2) Set the proper labels to indicate your patch is ready
See Git Immersion for more information.
repo abandon <branch name>to abandon any changes (commits) that have not been uploaded.
repo start <branch> <project>to start repo listening for changes through git.
repo upload <project name>to upload committed changes to the remote review server.
git add <file name>to stage a file that has been changed or added.
git commit -m "comment"to commit a change.
git reset HEAD <file name>to unstage a file.
git revert HEADto undo the last commit.
git statusto see the status of a project.
--date="DATE"to specify the date of change if necessary. DATE has to be in RFC 2822, ISO 8601 or git internal time format.
RFC 2822: Wed, 17 Jan 2018 17:39:48 +0100
ISO 8601: 2018-01-17T17:39:48+0100
git internal format: 1516210788 +0100
--author="NAME <EMAIL>"to name the author if you did not write the patch yourself.
--amendto modify the last commit.