Document Purpose: Walkthrough configuring your workstation and a Gerrit account. This is needed to participate in OpenBMC's Gerrit-based code reviews.
Prerequisites: Current Linux, Mac, or Windows system. Git packages installed. E-mail account (recommended to use the same e-mail address for both Gerrit and GitHub).
git config --global --add user.name "Your name" (eg. John Smith)
git config --global --add user.email "youremail@your-domain" (eg. jsmith@somedomain.com)
git config --global --add diff.tool "preferred diff tool" (eg. gvimdiff or meld)
Create keys: ssh-keygen -t rsa -C "your_email@your-domain"
Add Keys to GitHub:
Add Keys to OpenBMC's Gerrit Server:
Add the following to ~/.ssh/config
:
Host openbmc.gerrit Hostname gerrit.openbmc-project.xyz Port 29418 User <Your Gerrit Username>
AFSTokenPassing no
to be added to the SSH entry if using AFS.chmod 600 ~/.ssh/*
Test connectivity to Gerrit by attempting to clone a repo
git clone ssh://openbmc.gerrit/openbmc/docs
Checking out files: 100% (45/45), done.
Inside the repo you just cloned, enter the following commands:
gitdir=$(git rev-parse --git-dir) scp -p -P 29418 openbmc.gerrit:hooks/commit-msg ${gitdir}/hooks
This will enhance the git commit
command to add a Change-Id
to your commit message which Gerrit uses to track the review.
Now that your workstation and Gerrit are configured, you are ready to make code changes and push them to Gerrit for code review. Here is what the basic workflow will look like.
git add [file1 file2 ... fileN]
git commit --signoff
git push origin HEAD:refs/for/master
MAINTAINERS
file in the repo.If you've completed all of the above steps successfully, that's it! You have now set up Gerrit and know how to submit your code changes for review!
Submitting changes for review is just one of many steps in the contributing process. Please see CONTRIBUTING for best practices.