summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2019-05-31 11:15:56 +0000
committerGerrit Code Review <gerrit@onap.org>2019-05-31 11:15:56 +0000
commit4745f4848bb3bc74669f9e1a40eeff5337868ef1 (patch)
treee4177cbffd546b9ad39d2ae1c8c1e0abd1eeffa3 /docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
parent489c62270bbbfd0b5da0ca0716f86a063575808b (diff)
parent21287a13ef9718db9fe52ae6275755f198560480 (diff)
Merge "Add caution to not modify ../ in git command" into dublin
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/include-documentation.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/include-documentation.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index 896c23170..89959914c 100644
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@ -58,6 +58,12 @@ The following sequence will do this over ssh.
If your access network restricts ssh, you will need to use equivalent
git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_.
+.. caution::
+
+ Don't replace ../ in *git submodule add* with any relative path on
+ your local file system. It refers to the location of your repository
+ on the server.
+
.. code-block:: bash
git clone ssh://$lfid@gerrit.onap.org:29418/doc
@@ -507,4 +513,3 @@ scan for output that applies to the files you are validating.
tox -espellcheck
more < docs/_build/spellcheck/output.txt
-