Using Repo and Git

Task reference

The task list below shows a summary of how to do common Repo and Git tasks. For complete quick-start information and examples, see Get source .

Installing Repo

$ curl http://android.git.kernel.org/repo > ~/bin/repo $ mkdir working-directory-name
$ cd working-directory-name
$ repo init -u git://android.git.kernel.org/platform/manifest.git

Synchronizing your client

To synchronize the files for all available projects:
$ repo sync

To synchronize the files for selected projects:
$ repo sync project1 project2 ...

Why use topic branches?

Start a topic branch in your local work environment whenever you begin a change, for example when you begin work on a bug or new feature.

A topic branch is not a copy of the original files; it is a pointer to a particular commit. This makes creating local branches and switching among them a light-weight operation. By using branches, you canisolateone aspect of your work from the others. For an interesting article about using topic branches, see Separating topic branches .

Creating topic branches

To start a topic branch using Repo:
$ repo start branchname

To verify that your new branch was created:
$ repo status

Using topic branches

To assign the branch to a particular project:
$ repo start branch name project

To switch back and forth among branches that you have created in your local work environment:
$ git checkout branchname

To see a list of existing branches:
$ git branch
or...
$ repo branches

The name of the current branch will be preceded by an asterisk.

Note:
A bug might be causing repo sync to reset the local topic branch. If git branch shows * (no branch) after you run repo sync, then run git checkoutagain.

Viewing client status

To list the state of your files:
$ repo status

To see uncommitted edits:
$ repo diff

Therepo diffcommand shows every local edit that you have made that would not go into the commit, if you were to commit right now.

To see every edit that would go into the commit if you were to commit right now, you need a Git command, git diff. Before running it, be sure you are down in the project directory:
$ cd ~/workingdirectory /project
$ git diff --cached

Recovering sync conflicts

If a repo sync shows sync conflicts:

1. View the files that are unmerged (status code = U).
2. Edit the conflict regions as necessary.
3. Change into the relevant project directory, run git add and git commit for the files in question, and then "rebase" the changes. For example:
   $ cd bionic
   $ git add bionic/*
   $ git commit
   $ git rebase --continue
   
   
4. When the rebase is complete start the entire sync again:
   $ repo syncbionic proj2 proj3 ... projN
   

Cleaning up your client files

To update your local working directory after changes are merged in Gerrit:
$repo sync

To safely remove stale topic branches:
$ repo prune

Deleting a client

Deleting a client will permanently delete any changes you have not yet uploaded for review.Becauseall state information is stored in your client, you only need to delete the directory from your filesystem:

$ cd ~
$ rm -rf working-directory-name

Scripting common tasks

You can use Repo to run the same program across all projects:

$ repo forall[proj1 proj2 ... projN ]-c 'echo $REPO_PROJECT $@ '[arg1 arg2 ... argN ]

The -c argument is evaluated through /bin/sh and any arguments after it are passed through as shell positional parameters.

Repo command reference

Repo usage takes the following form:
repo command options

Optional elements are shown in brackets[ ]. Once Repo is installed, you can get information about any command by running
repo help command

init

repo init -u url [options ]

sync

repo sync [project-list ]

How Repo synchronization works

1. If the project has never been synchronized, then repo sync is equivalent to git clone. All branches in the remote repository are copied to the local project directory.
2. If the project has already been synchronized once, then repo sync is equivalent to:
   git remote update
   git rebase origin/branch
   where branch is the currently checked-out branch in the local project directory. If the local branch is not tracking a branch in the remote repository, then no synchronization will occur for the project.
   
   If the git rebase operation results in merge conflicts, you will need to use the normal Git commands (for example, git rebase --continue) to resolve the conflicts.
   

upload

repo upload [project-list ]

diff

repo diff [project-list ]

download

repo download target change

forall

repo forall [project-list ] -c command [arg. ..]

help

repo help [command ]

prune

repo prune [project-list ]

start

repo start newbranchname [project-list ]

status

repo status [project-list ]

Git and Repo cheatsheet

Click on the cheatsheet to open it in a new window for easier printing.

Terminology

Staged changes
Changes marked by git add for inclusion in the next commit's snapshot.

Commit
At intervals, you use git commit to save a snapshot of the staged files and a log message that describes the change.

Manifest
A manifest file that contains a list of repositories and a mapping of where the files from these repositories will be located within your working directory. When you synchronize your files, the files contained in the repositories that are listed in the manifest will be pulled into your working directory.