docs/gettingstarted/developers/gitreview.rst

   1 .. _gitreview:
   2
   3 *******************************
   4 Getting a Patch Reviewed
   5 *******************************
   6
   7 This section describes how to get FD.io VPP sources reviewed and merged.
   8
   9 Setup
  10 ========
  11
  12 If you don't have a Linux Foundation ID, `create one here. <https://identity.linuxfoundation.org/>`_
  13
  14 With your Linux Foundation ID credentials sign into `Gerrit Code Review at gerrit.fd.io <https://gerrit.fd.io/r/login/%23%2Fq%2Fstatus%3Aopen>`_
  15
  16 `Install git-review, <https://www.mediawiki.org/wiki/Gerrit/git-review>`_ which is a "command-line tool for Git / Gerrit to submit a change or to fetch an existing one."
  17
  18 If you're on Ubuntu, install keychain:
  19
  20 .. code-block:: console
  21
  22     $ sudo apt-get install keychain
  23
  24 ssh keys
  25 -------------
  26
  27 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.
  28
  29 Create your public and private ssh key with:
  30
  31 .. code-block:: console
  32
  33     $ ssh-keygen -t rsa
  34     $ keychain
  35     $ cat ~/.ssh/id_rsa.pub
  36
  37 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 <https://gerrit.fd.io/r/#/settings/ssh-keys>`_, click **Add Key ...**, paste your public key, and finally click **Add**.
  38
  39 .. _clone-ssh:
  40
  41 Clone with ssh
  42 ==============
  43
  44 Clone the repo with:
  45
  46 .. code-block:: console
  47
  48     $ git clone ssh://gerrit.fd.io:29418/vpp
  49     $ cd vpp
  50
  51 This will only work if the name of the user on your system matches your Gerrit username.
  52
  53 Otherwise, clone with:
  54
  55 .. code-block:: console
  56
  57     $ git clone ssh://<YOUR_GERRIT_USERNAME>@gerrit.fd.io:29418/vpp
  58     $ cd vpp
  59
  60 When attempting to clone the repo Git will prompt you asking if you want to add the Server Host Key to the list of known hosts. Enter **yes** and press the **Enter** key.
  61
  62 Git Review
  63 ===========
  64
  65 The VPP documents use the gerrit server, and git review for submitting and fetching patches.
  66
  67
  68 New patch
  69 -----------------
  70
  71 When working with a new patch, use the following commands to get your patch reviewed.
  72
  73 Make sure you have modified the correct files by issuing the following commands:
  74
  75 .. code-block:: console
  76
  77     $ git status
  78     $ git diff
  79
  80 Then add and commit the patch. You may want to add a tag to the commit comments.
  81 For example for a document with only patches you should add the tag **docs:**.
  82
  83 .. code-block:: console
  84
  85     $ git add <filename>
  86     $ git commit -s -m "<*TAG*>: <*COMMIT_MESSAGE*>"
  87     $ git review
  88
  89 If you are creating a draft, meaning you do not want your changes reviewed yet, do the following:
  90
  91 .. code-block:: console
  92
  93     $ git review -D
  94
  95 After submitting a review, reset where the HEAD is pointing to with:
  96
  97 .. code-block:: console
  98
  99     $ git reset --hard origin/master
 100
 101 Existing patch
 102 -----------------------
 103
 104 The "change number" used below is in the URL of the review.
 105
 106 After clicking an individual review, the change number can be found in the URL at "https://gerrit.fd.io/r/#/c/<*CHANGE_NUMBER*>/"
 107
 108 To view an existing patch:
 109
 110 .. code-block:: console
 111
 112     $ git review -d <change number>
 113     $ git status
 114     $ git diff
 115
 116 .. caution::
 117
 118     If you have made changes and do "git review -d <change number>", your current
 119     changes will try to be stashed so that the working tree can change to the review branch
 120     you specified. If you want to make sure you don't lose your changes, clone another Gerrit
 121     repo into a new directory using the cloning steps shown in :ref:`clone-ssh`, and perform
 122     "git review -d <change number>" in this new directory.
 123
 124 To modify an existing patch, make sure you modified the correct files, and apply the patch with:
 125
 126 .. code-block:: console
 127
 128     $ git review -d <change number>
 129     $ git status
 130     $ git diff
 131
 132     $ git add <filename>
 133     $ git commit --amend
 134     $ git review
 135
 136 When you're done viewing or modifying a branch, get back to the master branch by entering:
 137
 138 .. code-block:: console
 139
 140     $ git reset --hard origin/master
 141     $ git checkout master
 142
 143 Resolving a Conflict
 144 --------------------------------
 145
 146 If a change has a conflict it should be resolved by entering:
 147
 148 .. code-block:: console
 149
 150     $ git-review -d <*Gerrit change #*>
 151     $ git rebase origin/master
 152        while (conflicts)
 153           <fix conflicts>
 154           $ git rebase --continue
 155     $ git review
 156
 157
 158