aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/gitreview.rst
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-07-26 12:45:10 -0400
committerDave Barach <openvpp@barachs.net>2018-07-26 18:34:47 +0000
commit06dcd45ff81e06bc8cf40ed487c0b2652d346a5a (patch)
tree71403f9d422c4e532b2871a66ab909bd6066b10b /docs/gettingstarted/writingdocs/gitreview.rst
parent1d65279ffecd0f540288187b94cb1a6b84a7a0c6 (diff)
Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/writingdocs/gitreview.rst')
-rw-r--r--docs/gettingstarted/writingdocs/gitreview.rst72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/gettingstarted/writingdocs/gitreview.rst b/docs/gettingstarted/writingdocs/gitreview.rst
new file mode 100644
index 00000000000..63916e1d752
--- /dev/null
+++ b/docs/gettingstarted/writingdocs/gitreview.rst
@@ -0,0 +1,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