]> granicus.if.org Git - esp-idf/commitdiff
docs: Separate "build and flash" into building then flashing
authorAngus Gratton <angus@espressif.com>
Thu, 10 May 2018 10:15:03 +0000 (18:15 +0800)
committerAngus Gratton <gus@projectgus.com>
Tue, 29 May 2018 06:34:45 +0000 (16:34 +1000)
Explains idf.py build as mentioned here: https://github.com/espressif/esp-idf/issues/1906#issuecomment-387557050

components/esp32/lib
docs/en/get-started/index.rst

index 8cd9fd455e98a5c818f2796b4b83107884b7874c..92a091649f7c8476580177e2a769b15d9c4c191f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 8cd9fd455e98a5c818f2796b4b83107884b7874c
+Subproject commit 92a091649f7c8476580177e2a769b15d9c4c191f
index 8722a42865809b7069fcacc48893b43fcd85230d..14ba2f2c6a63127f6304533fbce288ac3bec23b4 100644 (file)
@@ -247,18 +247,29 @@ Here are couple of tips on navigation and use of ``menuconfig``:
 \r
 .. _get-started-build-flash:\r
 \r
-Build and Flash\r
-===============\r
+Build The Project and Flash\r
+===========================\r
 \r
 .. highlight:: bash\r
 \r
-Now you can build and flash the application. Run::\r
+Now you can build the project. Run::\r
+\r
+    idf.py build\r
+\r
+This command will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries.\r
+\r
+Flash To A Device\r
+=================\r
+\r
+Now you can flash the application to the ESP32 board. Run::\r
 \r
     idf.py -p PORT flash\r
 \r
 Replace PORT with the name of your ESP32 board's serial port. On Windows, serial ports have names like ``COM1``. On MacOS, they start with ``/dev/cu.``. On Linux, they start with ``/dev/tty``. (See :doc:`establish-serial-connection` for full details.)\r
 \r
-This will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries, and flash these binaries to your ESP32 board.\r
+This step will flash the binaries that you just built to your ESP32 board.\r
+\r
+.. note:: Running ``idf.py build`` before ``idf.py flash`` is not actually necessary, the flash step will automatically build the project if required before flashing.\r
 \r
 .. highlight:: none\r
 \r