Merging FD.io VPP documents

This section describes how to get FD.io VPP documents reviewed and merged.

Setup

If you don’t have a Linux Foundation ID, create one here.

With your Linux Foundation ID credentials sign into Gerrit Code Review at gerrit.fd.io

Install git-review, which is a “command-line tool for Git / Gerrit to submit a change or to fetch an existing one.”

If you’re on Ubuntu, install keychain:

$ sudo apt-get install keychain

ssh keys

To get FD.io VPP documents reviewed the VPP repository should be cloned with ssh. You should be logged into Gerrit Code Review as noted above.

Create your public and private ssh key with:

$ ssh-keygen -t rsa
$ keychain
$ cat ~/.ssh/id_rsa.pub

Copy all the contents of the public key (id_rsa.pub) output by the above cat command. Then go to your SSH Public keys settings page, click Add Key …, paste your public key, and finally click Add.

Clone with ssh

Clone the repo with:

$ git clone ssh://gerrit.fd.io:29418/vpp
$ cd vpp

This will only work if the name of the user on your system matches your Gerrit username.

Otherwise, clone with:

$ git clone ssh://YOUR_GERRIT_USERNAME@gerrit.fd.io:29418/vpp
$ cd vpp

When attempting to clone the repo it will ask if you want to add the Server Host Key to the list of known hosts. Type yes and hit enter.

Git Review

The VPP documents use the gerrit server and git review for submitting and fetching patches.

New patch

When working with new patch use the following to get your patch reviewed.

Make sure you have modified the correct files with:

$ git status
$ git diff

Then add and commit the patch. For documents we will add a tag DOCS:

$ git add <filename>
$ git commit -s -m "DOCS: <COMMIT_MESSAGE>"
$ git review

If you are creating a draft, meaning you do not want your changes reviewed yet, do the following:

$ git review -D

After submitting a review, reset where the HEAD is pointing to with:

$ git reset --hard origin/master

Existing patch

The “change number” used below is in the URL of the review.

After clicking an individual review, the change number can be found in the URL at “https://gerrit.fd.io/r/#/c/<CHANGE_NUMBER>/”

To view an existing patch:

$ git review -d <change number>
$ git status
$ git diff

Caution

If you have made changes and do “git review -d <change number>”, your current changes will try to be stashed so that the working tree can change to the review branch you specified. If you want to make sure you don’t lose your changes, clone another Gerrit repo into a new directory using the cloning steps shown in Clone with ssh, and perform “git review -d <change number>” in this new directory.

To modify an existing patch, make sure you modified the correct files, and apply the patch with:

$ git review -d <change number>
$ git status
$ git diff

$ git add <filename>
$ git commit --amend
$ git review

When you’re done viewing or modifying a branch, get back to the master branch with:

$ git reset --hard origin/master
$ git checkout master