summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/gitreview.rst
blob: 63916e1d7529ce5a8e27f4c3e795a7a3186353c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. _gitreview:

***************************
Merging FD.io VPP documents
***************************

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

Git Review
==========

The VPP documents use the gerrit server and git review.

Clone with ssh
--------------

To get FD.io VPP documents reviewed the VPP repository should be cloned with ssh.

Use the following to setup you ssh key

.. code-block:: console

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

Copy that key to the gerrit server.
Then clone the repo with:

.. code-block:: console

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

New patch
--------------

To get a new patch reviewed use the following:

.. code-block:: console

    git status
    git add <filename>
    git commit -s
    git review

If the patch is a draft use the following:

.. note::

    git review -D


To get back to the master:

.. code-block:: console

    git reset --hard origin/master
    git checkout master

Existing patch
--------------

To modify an existing patch:


.. code-block:: console

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