Docs: Add note about unusual submodule messages when cloning on Windows

Related to github #11
This commit is contained in:
Angus Gratton 2016-09-16 18:05:52 +10:00
parent cdd1b95b6e
commit 90017397e5

View 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