From: agardner <agardner@linuxfoundation.org>
Date: Mon, 28 Aug 2017 19:51:43 +0000 (-0400)
Subject: Add docs on how to remove a submodule
X-Git-Tag: opnfv-5.0.0~1139^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=1f7c3cefc0563d9e55c53b916d3c7fa3d5e43a6d;p=opnfvdocs.git

Add docs on how to remove a submodule

Change-Id: Ic2ff79ef9d9937466183bfeacc9fec92116dca02
Signed-off-by: agardner <agardner@linuxfoundation.org>
---

diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index 7e9d54462..d1a5a6227 100644
--- a/docs/how-to-use-docs/include-documentation.rst
+++ b/docs/how-to-use-docs/include-documentation.rst
@@ -240,4 +240,15 @@ Clone the opnfvdocs repository and your submodule to .gitmodules following the c
   git submodule init $reponame/
   git submodule update $reponame/
   git add .
+  git commit -sv
   git review
+
+Removing a project repository as a submodule
+--------------------------
+  git rm docs/submodules/$reponame
+  rm -rf .git/modules/$reponame
+  git config -f .git/config --remove-section submodule.$reponame 2> /dev/null
+  git add .
+  git commit -sv
+  git review
+