]> granicus.if.org Git - esp-idf/commitdiff
cmake docs: Specify feature/cmake branch when cloning from Github
authorAngus Gratton <angus@espressif.com>
Tue, 8 May 2018 14:05:43 +0000 (22:05 +0800)
committerAngus Gratton <gus@projectgus.com>
Tue, 8 May 2018 14:05:43 +0000 (22:05 +0800)
As mentioned here https://github.com/espressif/esp-idf/issues/1906#issuecomment-387377493

docs/en/get-started/index.rst

index b87a55076a8344cd075b5b0c701e8ad1875703fc..39148baadbcca4c3e3aa2df48b3196239b5da54e 100644 (file)
@@ -129,7 +129,7 @@ For Windows Command Prompt users, the equivalent commands are::
 \r
     mkdir %userprofile%\esp\r
     cd %userprofile%\esp\r
-    git clone --recursive https://github.com/espressif/esp-idf.git\r
+    git clone --branch feature/cmake --recursive https://github.com/espressif/esp-idf.git\r
 \r
 .. highlight:: bash\r
 .. note::\r
@@ -139,6 +139,12 @@ For Windows Command Prompt users, the equivalent commands are::
         cd esp-idf\r
         git submodule update --init\r
 \r
+.. note::\r
+\r
+   The CMake-based build system preview uses a different Git branch to the default. This branch is ``feature/cmake``. If you missed the ``--branch`` option when cloning then you can switch branches on the command line::\r
+\r
+         cd esp-idf\r
+         git checkout feature/cmake\r
 \r
 .. _get-started-setup-path:\r
 \r
@@ -211,7 +217,7 @@ For Windows Command Prompt users::
     cd %userprofile%\esp\r
     idf.py menuconfig\r
 \r
-.. note:: If you get an error about ``idf.py`` not being found, check the ``tools`` directory is part of your Path as described above in :ref:`get-started-setup-path`.\r
+.. note:: If you get an error about ``idf.py`` not being found, check the ``tools`` directory is part of your Path as described above in :ref:`get-started-setup-path`. If there is no ``idf.py`` in the ``tools`` directory, check you have the correct branch for the CMake preview as shown under :ref:`get-started-get-esp-idf`.\r
 \r
 .. note:: Windows users, the Python 2.7 installer will try to configure Windows to associate files with a ``.py`` extension with Python 2. If a separate installed program (such as Visual Studio Python Tools) has created an association with a different version of Python, then running ``idf.py`` may not work. You can either run ``C:\Python27\python idf.py`` each time instead, or change the association that Windows uses for ``.py`` files.\r
 \r