From 8b43b97d445e46588390e119bab4fded203a3ee2 Mon Sep 17 00:00:00 2001 From: Krzysztof Opasiak Date: Wed, 29 May 2019 17:29:48 +0200 Subject: Add caution to not modify ../ in git command Using incorrect repository location is hard to catch during review and merging it causes all jenkins verify job to fail. Thus let's add a warning to the documentation to warn potential users and avoid such incidents. Issue-ID: SECCOM-239 Signed-off-by: Krzysztof Opasiak Change-Id: I6b00a5bc6f34d33f2576c802eccf541069499d84 --- .../onap-developer/how-to-use-docs/include-documentation.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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 `_. +.. 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 - -- cgit 1.2.3-korg