From: Angus Gratton <angus@espressif.com>
Date: Thu, 10 May 2018 10:15:03 +0000 (+0800)
Subject: docs: Separate "build and flash" into building then flashing
X-Git-Tag: v3.1-rc2~9^2~19^2~15
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=979568fa0b71c9d818ffc04f656c8a007beff4e3;p=esp-idf

docs: Separate "build and flash" into building then flashing

Explains idf.py build as mentioned here: https://github.com/espressif/esp-idf/issues/1906#issuecomment-387557050
---

diff --git a/components/esp32/lib b/components/esp32/lib
index 8cd9fd455e..92a091649f 160000
--- a/components/esp32/lib
+++ b/components/esp32/lib
@@ -1 +1 @@
-Subproject commit 8cd9fd455e98a5c818f2796b4b83107884b7874c
+Subproject commit 92a091649f7c8476580177e2a769b15d9c4c191f
diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst
index 8722a42865..14ba2f2c6a 100644
--- a/docs/en/get-started/index.rst
+++ b/docs/en/get-started/index.rst
@@ -247,18 +247,29 @@ Here are couple of tips on navigation and use of ``menuconfig``:
 
 .. _get-started-build-flash:
 
-Build and Flash
-===============
+Build The Project and Flash
+===========================
 
 .. highlight:: bash
 
-Now you can build and flash the application. Run::
+Now you can build the project. Run::
+
+    idf.py build
+
+This command will compile the application and all the ESP-IDF components, generate bootloader, partition table, and application binaries.
+
+Flash To A Device
+=================
+
+Now you can flash the application to the ESP32 board. Run::
 
     idf.py -p PORT flash
 
 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.)
 
-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.
+This step will flash the binaries that you just built to your ESP32 board.
+
+.. 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.
 
 .. highlight:: none