You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/api-guides/build-system.rst
+7-10Lines changed: 7 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ concept of "components"
6
6
7
7
Read this document if you want to know how to organise a new ESP-IDF project.
8
8
9
-
We recommend using the esp-idf-template_ project as a starting point for your project.
9
+
We recommend using the project_template project at directory of examples/get-started as a starting point for your project.
10
10
11
11
Using the Build System
12
12
======================
@@ -17,19 +17,17 @@ Overview
17
17
========
18
18
19
19
An ESP-IDF project can be seen as an amalgamation of a number of components.
20
-
For example, for a webserver that shows the current humidity, there could be:
20
+
For example, for a http request example that shows the current humidity, there could be:
21
21
22
-
- The ESP32 base libraries (libc, rom bindings etc)
22
+
- The SoC base libraries (libc, rom bindings etc)
23
23
- The WiFi drivers
24
24
- A TCP/IP stack
25
25
- The FreeRTOS operating system
26
-
- A webserver
27
-
- A driver for the humidity sensor
28
26
- Main code tying it all together
29
27
30
28
ESP-IDF makes these components explicit and configurable. To do that,
31
29
when a project is compiled, the build environment will look up all the
32
-
components in the ESP-IDF directories, the project directories and
30
+
components in the SDK directories, the project directories and
33
31
(optionally) in additional custom component directories. It then
34
32
allows the user to configure the ESP-IDF project using a a text-based
35
33
menu system to customize each component. After the components in the
@@ -567,7 +565,7 @@ The file's contents will be added to the .rodata section in flash, and are avail
567
565
568
566
The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files.
569
567
570
-
For an example of using this technique, see :example:`protocols/https_request` - the certificate file contents are loaded from the text .pem file at compile time.
568
+
For an example of using this technique, see :example:`protocols/https_mbedtls` - the certificate file contents are loaded from the text .pem file at compile time.
571
569
572
570
573
571
Fully Overriding The Component Makefile
@@ -586,7 +584,6 @@ $(COMPONENT_LIBRARY) for the project make process to link into the app binary.
586
584
is overridden then the component can instruct the linker to link other binaries instead.)
.. _GNU Make Manual: https://www.gnu.org/software/make/manual/make.html
591
588
592
589
@@ -605,11 +602,11 @@ Save flash arguments
605
602
606
603
There're some scenarios that we want to flash the target board without IDF. For this case we want to save the built binaries, esptool.py and esptool write_flash arguments. It's simple to write a script to save binaries and esptool.py. We can use command ``make print_flash_cmd``, it will print the flash arguments::
0 commit comments