DOCS: Cleanup Getting Started

[vpp.git] / docs / gettingstarted / developers / gitreview.rst

diff --git a/docs/gettingstarted/writingdocs/gitreview.rst b/docs/gettingstarted/developers/gitreview.rst
similarity index 83%
rename from docs/gettingstarted/writingdocs/gitreview.rst
rename to docs/gettingstarted/developers/gitreview.rst
index 146b06f..f727fb1 100644 (file)
--- a/docs/gettingstarted/writingdocs/gitreview.rst
+++ b/docs/gettingstarted/developers/gitreview.rst
@@ -1,10 +1,10 @@
 .. _gitreview:
 
 *******************************
-Merging FD.io VPP documents
+Getting a Patch Reviewed
 *******************************
 
-This section describes how to get FD.io VPP documents reviewed and merged.
+This section describes how to get FD.io VPP sources reviewed and merged.
 
 Setup
 ========
@@ -77,12 +77,13 @@ 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:**
+Then add and commit the patch. You may want to add a tag to the commit comments.
+For example for document only patches you should add the tag **DOCS:**.
 
 .. code-block:: console
 
     $ git add <filename>
-    $ git commit -s -m "DOCS: <COMMIT_MESSAGE>"
+    $ git commit -s -m "<*TAG*>: <*COMMIT_MESSAGE*>"
     $ git review
 
 If you are creating a draft, meaning you do not want your changes reviewed yet, do the following:
@@ -102,7 +103,7 @@ 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>/"
+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:
 
@@ -138,3 +139,19 @@ When you're done viewing or modifying a branch, get back to the master branch wi
 
     $ git reset --hard origin/master
     $ git checkout master
+
+Resolving a Conflict
+--------------------------------
+
+If a change has a conflict it should be resolved with the following:git-review -d <Gerrit change #>
+
+.. code-block:: console
+
+    $ git rebase origin/master
+       while (conflicts)
+          <fix conflicts>
+          $ git rebase --continue
+    $ git review
+
+
+