Commit Graph

97 Commits

Author SHA1 Message Date
Marius Vikhammer
124a43e9ec build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES
ADDITIONAL_MAKE_CLEAN_FILES is deprecated and only worked with make.
Replaced with the new ADDITIONAL_CLEAN_FILES (CMake 3.15) which also works with ninja.
2023-05-10 09:56:15 +08:00
Marius Vikhammer
4cbabc0542 docs: fixed EXTRA_COMPONENT_DIRS being mispelled as EXTRA_COMPONENTS_DIRS in build-system guide 2023-03-17 11:49:51 +08:00
Shang Zhou
e760a54e37
docs: update CN translation for build-system.rst 2022-12-19 15:25:30 +01:00
Angus Gratton
8468ea3dcc
build system: Add idf_component_add_link_dependency function, use for spi_flash overriding 2022-12-19 15:25:30 +01:00
Marius Vikhammer
055f18f27a docs: sync chinese translation of build-system.rst 2022-10-11 14:27:04 +08:00
Uday M S
83c0a7dc93 Update build-system.rst
Rearranged few lines of folder directory description
2022-10-11 14:26:55 +08:00
Shubham Kulkarni
1bb1b70e0f docs: Add documentation for define extra partition subtypes through build system 2022-08-03 05:18:37 +00:00
daiziyan
b995b584bd docs: translated removed-components and build-system 2022-07-26 14:55:01 +08:00
Cao Sen Miao
d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
daiziyan
e6a7fee2b4 docs: udpate CN translation for build-system 2022-06-08 19:40:04 +08:00
Michael (XIAO Xufeng)
a0c2252756 build_system: fixed issue that default.target may override other custom configs 2022-06-02 11:08:59 +08:00
Djordje Nedic
facab8c5a7 tools: Increase the minimal supported CMake version to 3.16
This updates the minimal supported version of CMake to 3.16, which in turn enables us to use more CMake features and have a cleaner build system.
This is the version that provides most new features and also the one we use in our latest docker image for CI.
2022-06-01 06:35:02 +00:00
Sergei Silnov
89518ee86a build & config: Check requirements of managed components of main and add interface versioning 2022-05-30 14:36:22 +02:00
Sergei Silnov
487603b51f build & config: Add IDF_COMPONENT_MANAGER build property 2022-05-26 12:48:27 +02:00
Marius Vikhammer
d485f6add8 Merge branch 'feature/arch_build_property' into 'master'
build-system: add property for architecture (riscv/xtensa)

Closes IDF-1754

See merge request espressif/esp-idf!18127
2022-05-24 08:46:09 +08:00
Marius Vikhammer
9362434c47 build-system: add property for architecture (riscv/xtensa)
riscv/xtensa is now a common component.
2022-05-20 09:00:32 +08:00
Marius Vikhammer
030e52f5d4 Merge branch 'feature/improve_doc_link_check' into 'master'
docs: fix broken links and re-enable linkchecker

Closes IDF-2640

See merge request espressif/esp-idf!17919
2022-05-19 15:52:17 +08:00
daiziyan
ca57e121e2 docs: udpate CN translation for readme and build-system 2022-05-11 19:49:16 +08:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Ivan Grokhotkov
598e8db29c
docs: update build system reference and migration guides for lwip
Previous commit removes lwip from the common requirements.
This commit updates the documentation to describe the resulting
changes.
2022-05-02 20:47:18 +02:00
Djordje Nedic
181618ab70 docs: Move the documentation about idf.py out from the build system documentation
This moves all the documentation relating to using idf.py out of the build system documentation in order to declutter and more logically group the documentation.
It is now present in the tools page under IDF Frontend - idf.py.
Additionally there has been lots of rewriting and some minor fixes on the way.
2022-04-22 17:38:04 +02:00
Hassan DRAGA
de7d093ef8
Fixing a file name typo (plug.c)
In [Example of component requirements] it shows "plug.c" while in the rest of the explanation it refer to "spark_plug.c", same thing with "plug.h".
2022-04-12 09:09:19 -04:00
Ivan Grokhotkov
273633ee31
build system: add WHOLE_ARCHIVE component property
This component property allows including all component object files
into the executable. It is equivalent to wrapping the component
library with -Wl,--whole-archive and -Wl,--no-whole-archive flags.

Closes https://github.com/espressif/esp-idf/issues/8667
2022-04-05 18:50:20 +02:00
Omar Chebib
2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
daiziyan
60741e3be8 docs: make line number consistent for build-system, configure-ft2232h-jtag, ble-mesh-architecture, building-openocd-macos, error-handling" 2022-02-18 11:18:40 +08:00
pedro.minatel
e4a766051c [Docs] Rebase conlicts fixed
[Docs] New getting started based on the ide and os selection
Missing file on zh_CN folder added
Added hidden toctree for missing files in CN version
docs: Added steps summary to the macOS procedures
[Docs] Changes on the titles and heading levels
[Docs] Review according to MR 15432
[Docs] Fixed the start a new project secction
2022-02-17 10:50:51 +00:00
Tomas Sebestik
fb12d03dc3 Drop Python 3.6 2022-02-10 07:20:52 +01:00
Marius Vikhammer
3e756e809e docs: update docs with S3 specific information. 2022-01-06 10:04:25 +08:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py
Closes https://github.com/espressif/esp-idf/issues/5126
2021-10-13 17:30:38 +08:00
daiziyan
c9e5b02c18 docs: update CN trans for blufi and build-system 2021-09-10 15:09:50 +08:00
mjcross
307bbf0b67 Add hint about sdkconfig.ci in IDF examples
Individual developers may not know about CI and may be confused by the sdkconfig.ci files in the examples.

Signed-off-by: Laukik Hase <laukik.hase@espressif.com>

Closes https://github.com/espressif/esp-idf/pull/7379
2021-08-23 16:32:01 +05:30
Angus Gratton
62d188ec21 docs: build system: Add explanation about handling cyclic dependencies
Partial resolution for https://github.com/espressif/esp-idf/issues/6968
2021-07-16 09:21:41 +10:00
Simon
0b9afa509f tools: Add docs subcommand docs which opens browser with documentation for current version of idf and model of your target
Add docs subcommand with options:
--no-browser - Prints url for current documentation instead of opens browser with documentation
--language - Select documentation language
--starting-page - Choice section of documentation to open
--version - Choice version of esp-idf
--target - Choice model of your target
2021-07-12 10:56:37 +02:00
Martin Gaňo
330d1cf2ae Fix autocomplete for bash 2021-06-11 01:59:36 +02:00
Angus Gratton
dc6b950257 doc: Add performance guides for execuion speed, binary size, RAM usage
Closes https://github.com/espressif/esp-idf/issues/7007
Closes https://github.com/espressif/esp-idf/issues/6715
Closes https://github.com/espressif/esp-idf/issues/3781
Closes https://github.com/espressif/esp-idf/issues/2566
2021-06-03 13:55:34 +10:00
Dai Zi Yan
e91861253f docs:updated CN tranlation for build-system, ulp, unit-tests, idf-monitor and linker-script-generation 2021-04-22 16:08:31 +08:00
Angus Gratton
da3dca1fdc Merge branch 'bugfix/change_component_ordering' into 'master'
cmake: swap priority between EXTRA_COMPONENT_DIRS and project components

Closes IDF-2864

See merge request espressif/esp-idf!12765
2021-04-01 07:23:00 +00:00
Renz Bagaporo
cd13a34e3e docs: add note how to override default build specifications 2021-03-29 21:18:17 +08:00
Renz Bagaporo
b5c3d4f615 cmake: swap priority between EXTRA_COMPONENT_DIRS and project components 2021-03-22 19:01:33 +08:00
Angus Gratton
738b07fe63 doc: Update the link to an example that embeds a file
Since we have the CA Certificate Store feature, https_request no longer needs to
embed any certs.
2021-03-09 10:28:52 +11:00
Renz Bagaporo
f2561f6360 docs: update list of common component requirements 2021-02-24 12:16:37 +08:00
Marius Vikhammer
548fd02d10 docs: initial update of programming guide for C3
Updates "front page" content, get-started, and api-guides with C3 content

Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
daiziyan
2e3367b97e update api-guides/build-system.rst to keep EN and CN in sync 2021-01-13 19:23:30 +08:00
martin.gano
346b002d9a enable autocompletion for command idf.py 2020-11-03 23:27:58 +01:00
Angus Gratton
52676974e4 doc: Add note about moving components or bootloader in an existing project
Based on some forum questions, i.e. https://esp32.com/viewtopic.php?f=13&t=16731&sid=107a5d613c97b68cf156b49579534c51
2020-10-26 16:41:24 +11:00
martin.gano
44f663447e docs: add description of python-clean command 2020-09-24 21:06:09 +02:00
martin.gano
b599f127b5 add new command to idf 2020-09-21 23:38:52 +02:00
Victor Lamoine
f09f3c9d07 Fix ccache documentation: environment variable is IDF_CCACHE_ENABLE
Merges https://github.com/espressif/esp-idf/pull/5753
2020-08-26 16:39:33 +10:00
Angus Gratton
ad295037a8 idf.py: Disable CMake --warn-uninitialized option by default
Can still be enabled by passing --cmake-warn-uninitialized on the command line

Prevents CMake warnings printed by default if IDF_PATH is underneath the CMake
project directory.

The reason for this is that CMake --warn-uninitialized only enables checks
inside the project directory (ie top-level CMakeLists.txt directory and
subdirectories), it doesn't enable for files included from other directories.

(The only way to enable warnings in other directories is to pass
--check-system-dirs and this looks like it's only useful for CMake's own
developers as it prints a lot of warnings from inside CMake otherwise - see
https://gitlab.kitware.com/cmake/cmake/-/issues/19645 )

Plan to follow up with a later commit to clean up most of the warnings (which
aren't problems for CMake execution), but we'll also disable this option by
default to avoid this unexpected triggering of IDF warnings.
2020-08-26 09:53:56 +10:00