]> granicus.if.org Git - esp-idf/commitdiff
Docs: Add note about unusual submodule messages when cloning on Windows
authorAngus Gratton <angus@espressif.com>
Fri, 16 Sep 2016 08:05:52 +0000 (18:05 +1000)
committerAngus Gratton <angus@espressif.com>
Fri, 16 Sep 2016 08:07:58 +0000 (18:07 +1000)
Related to github #11

docs/windows-setup.rst

index a368e3305cf5d18b80cb2ce40a5b2e90a1c76ae0..baea1ac40b27a1a7c4ac67fc295537cde893bc30 100644 (file)
@@ -50,6 +50,8 @@ Change to the directory you want to clone the SDK into by typing a command like
 
 If you'd rather use a Windows UI tool to manage your git repositories, this is also possible. A wide range are available.
 
+*NOTE*: While cloning submodules, the ``git clone`` command may print some output starting ``': not a valid identifier...``. This is a `known issue`_ but the git clone still succeeds without any problems.
+
 Step 3: Starting a project
 ==========================
 
@@ -76,3 +78,4 @@ If you'd like to use the Eclipse IDE instead of running ``make``, check out the
 .. _Eclipse: eclipse-setup.rst
 .. _MSYS2: https://msys2.github.io/
 .. _github: https://github.com/espressif/esp-idf-template
+.. _known issue: https://github.com/espressif/esp-idf/issues/11