From 06dcd45ff81e06bc8cf40ed487c0b2652d346a5a Mon Sep 17 00:00:00 2001 From: John DeNisco Date: Thu, 26 Jul 2018 12:45:10 -0400 Subject: Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco --- docs/gettingstarted/writingdocs/gitreview.rst | 72 +++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 docs/gettingstarted/writingdocs/gitreview.rst (limited to 'docs/gettingstarted/writingdocs/gitreview.rst') 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 + 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 + git commit --amend + git review -- cgit 1.2.3-korg