Setting up Gerrit

From Qt Wiki
Jump to: navigation, search


All projects under the Qt Open Governance umbrella are hosted on our Gerrit Instance. There is an official mirror and browser of these repositories.

In order to be able to propose changes to those projects, you have to first setup your Gerrit account and get Qt's sourcecode, following the steps below:

  1. Set up a Gerrit account
  2. Tweak your SSH config as instructed here
  3. Use the recommended Git settings, defined here
  4. Get the source code of the projects you want to contribute to

Moreover, if you did not use the init-repository scripts to get the source code, you will have to manually:

  1. Set up the git commit hooks .
  2. Set up a Gerrit git remote.

Once all the steps above have been completed, you're ready to submit your patch to Qt!

How to get started - Gerrit registration

  1. Create a Qt account, if you don't yet have one.
    • Note: The email address you use to contribute to the Qt Project will be publicly visible in the Git history. Use an alias + a custom e-mail address if you want to stay anonymous (this is discouraged)
  2. Log into https://codereview.qt-project.org with your Qt account.
  3. Go to the Settings page: https://codereview.qt-project.org/settings/
  4. Go to "Settings" -> "Contact Information" and register your email address, if it hasn't been automatically registered.
    • Note: Pay special attention to the username listed on the front of the settings page because it will be used throughout this process. It is case sensitive and all lowercase from the username you signed up with.
  5. You will receive a confirmation email; click on the link inside to finalize your registration.
    • If you use Outlook, manually copy the link including any trailing equal signs into the browser.
  6. Go to "Settings"-> "SSH Public Keys" and upload your public SSH Key
  7. If you are behind a firewall that blocks SSH access:
    1. Go to "Settings" -> "HTTP Password"
    2. Click "Generate Password"
    3. Add the following line to your ~/.netrc (Windows: ​%USERPROFILE%\_netrc):
      machine codereview.qt-project.org login <Gerrit username> password <Generated password>

Local Setup

Configure SSH properly (the URLs below rely on this). Add this to your ~/.ssh/config (Windows: C:\Users\%USERNAME%\.ssh\config):

Host codereview.qt-project.org
Port 29418
User <Gerrit/Jira username>
IdentityFile <path_to_your_ssh_key>
Ciphers +aes256-cbc

IdentityFile will usually be something like ~/.ssh/id_rsa_keynamehere, on Linux; if it's just ~/.ssh/id_rsa (the default), you can leave out the IdentityFile line.

Configuring Git

We are developing in a heterogeneous environment with both Unix and Windows machines. Therefore it is imperative to have all files in the repository in the canonical LF-only format. Therefore, Windows users must run

$ git config --global core.autocrlf true

to automatically get CRLF line endings which are suitable for the native tools, and Unix users should use

$ git config --global core.autocrlf input

(this is a safety measure for the case where files with CRLF line endings get into the file system- this can happen when archives are unpacked, attachments saved, etc.).

To be able to create commits which can be pushed to the server, you need to set up your committer information correctly:

$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

Please do not use nicknames or pseudonyms instead of the real name unless you have really good reasons. Gerrit will not accept your commits unless the committer information matches the email address(es) you registered.

To facilitate following the style guide for commit messages, it is recommended to install the Qt commit message template:

$ git config --global commit.template <path to qt5.git or qt.git>/.commit-template

A common mistake is forgetting to add new files to a commit. Therefore it is recommended to set up git to always show them in git stat and git commit, even if this is somewhat slower (especially on Windows):

$ git config --global status.showuntrackedfiles all

Pre-2.0 git has a somewhat stupid default that git push will push all branches to the upstream repository, which is almost never what you want. To fix this, use:

$ git config --global push.default tracking

This is not relevant for mainline branches under Gerrit control, as all pushing happens with refs anyway, but it may be important for your private clones.

Sometimes it is necessary to resolve the same conflicts multiple times. Git has the ability to record and replay conflict resolutions automatically, but - surprise surprise - it is not enabled by default. To fix it, run:

$ git config --global rerere.enabled true
$ git config --global rerere.autoupdate true # this saves you the git add, but you should verify the result with git diff --staged

git pull will show a nice diffstat, so you get an overview of the changes from upstream. git pull --rebase does not do that by default. But you want it:

$ git config --global rebase.stat true

To get nicely colored patches (from git diff, git log -p, git show, etc.), use this:

$ git config --global color.ui auto
$ git config --global core.pager "less -FRSX"

Git supports aliases which you can use to save yourself some typing. For example, these (any similarity with subversion command aliases is purely accidental ;)):

$ git config --global alias.di diff
$ git config --global alias.ci commit
$ git config --global alias.co checkout
$ git config --global alias.ann blame
$ git config --global alias.st status

Getting the source code

Cloning Qt5

You should clone from the official mirror and track changes from there in order to keep the load on Gerrit down.

This guide will show you how to get the source code.

After getting the source code, if you did not use the init-repository script to clone the sourcecode as described in the guide, or you want to manually clone only a submodule, make sure you also manually set up the git commit hooks and set up a git remote that point to Qt's gerrit instance.

Cloning Qt Creator

$ git clone git://code.qt.io/qt-creator/qt-creator.git

Setup the gerrit remote

$ git remote add gerrit ssh://codereview.qt-project.org/qt-creator/qt-creator

If you are behind a SSH-blocking firewall, use the https protocol:

$ git remote add gerrit https://codereview.qt-project.org/p/qt-creator/qt-creator

Setting up git hooks

NOTE: This is only needed if you did NOT use the init-repository script to get the sourcecode, that automatically configures the git hooks for you.

To set up the git hooks, install the hook generating Commit-Id files into your top level project directory, as well as all sub-repositories (e.g. qtbase.git) either through

$ gitdir=$(git rev-parse --git-dir); scp -p codereview.qt-project.org:hooks/commit-msg ${gitdir}/hooks/

or by downloading the file via browser: commit-msg and putting it into the .git/hooks directory (make sure it is executable).

It is recommended to install the git_post_commit_hook from the qtrepotools repository. This gives you the checks of the Sanity Bot locally. To do this, save the script

#! /bin/sh
exec "<path to git clone>/qtrepotools/git-hooks/git_post_commit_hook" "$@"

into each <path to git clone>/.git/hooks/post-commit

NOTE: Starting with git 1.7.8, if <module name>/.git contains gitdir: ../.git/modules/<module name>, you need to put the submodule hooks in .git/modules/<module name>/hooks instead of <module name>/.git/hooks.


Setting up gerrit git remote

In order to easily push your changes to Gerrit, we recommend setting a git remote that points to gerrit. Follow the instructions in one (or more) of the following subsections, depending on which Qt repositories you want to setup Gerrit for.

Qt5 gerrit git remote

If you downloaded the sourcecode of Qt5 (or just one of its modules) using something else than the init-repository script, you will have to manually set up the gerrit git remote. You don't have to do this if you cloned the Qt5 sourcecode using the init-repository script as described in #Cloning Qt5. That handles it for you.

$ git remote add gerrit ssh://codereview.qt-project.org/qt/<qt5 or the submodule name you have checked out>

If you are behind a SSH-blocking firewall, use the https protocol:

$ git remote add gerrit https://codereview.qt-project.org/p/qt/<qt5 or the submodule name you have checked out>

QtCreator gerrit git remote

$ git remote add gerrit ssh://codereview.qt-project.org/qt-creator/qt-creator

If you are behind a SSH-blocking firewall, use the https protocol:

$ git remote add gerrit https://codereview.qt-project.org/p/qt-creator/qt-creator

Pushing your local changes to gerrit

See Gerrit Introduction.