daiziyan
5a32b53431
docs: udpate CN translation for build-system
2023-03-03 20:02:50 +01:00
Sergei Silnov
bb272d1b0a
build & config: Check requirements of managed components of main and add interface versioning
2023-03-03 20:02:49 +01:00
Sergei Silnov
c3969b789e
build & config: Add IDF_COMPONENT_MANAGER build property
2022-05-27 12:57:00 +02:00
Marius Vikhammer
02bf07a1a0
docs: update docs with S3 specific information.
2022-01-06 10:14:54 +08: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
Angus Gratton
a9dd9e3017
Merge branch 'feature/embed_generated_files' into 'master'
...
cmake: allow embedding files to be dependent on a target
See merge request espressif/esp-idf!8535
2020-08-04 14:39:49 +08:00
Renz Bagaporo
ebf07d353d
cmake: allow overriding kconfig, kconfig_projbuild on registration
2020-06-16 20:42:00 +08:00
Renz Bagaporo
f8d0c5770b
cmake: take note of component overriden dir
2020-06-16 20:42:00 +08:00
Renz Bagaporo
aed204ce6f
cmake: allow embedding to depend on a target
2020-04-29 12:34:25 +08:00
Renz Bagaporo
07f9978df7
cmake: add elf dir information
...
Solves https://www.esp32.com/viewtopic.php?f=13&t=14784&p=57557&hilit=assumes#p57557
2020-04-07 17:19:33 +08:00
Angus Gratton
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
Ivan Grokhotkov
b497819667
docs: update esp32s2 summary page
...
- Refer to the toolchain links on IDF Tools page
- Update the wording around v4.1/v4.2 releases
- Remove the section about 3 different versions (of S2-beta)
- Add link to the list of features maintained externally
2020-03-16 14:40:37 +11:00
Angus Gratton
8887f79bef
cmake: Add warnings that convert_to_cmake.py doesn't calculate component requirements
...
Any component which requires another component will need this manually
added to its CMakeLists.txt file.
2020-03-02 14:45:03 +11:00
Roland Dobai
5c0cd9417d
Docs: Encourage to used Python 3
2020-02-24 12:55:55 +01:00
Angus Gratton
3b498a0576
Merge branch 'bugfix/confserver_hex_types' into 'master'
...
confserver: Standardize and document the handling of hex values
See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Angus Gratton
99cdddeb63
docs: Fix broken or incorrect link roles to IDF files & directories
2020-02-18 10:34:11 +11:00
Angus Gratton
d9d7a906b1
confserver docs: Merge the build-system docs info about confserver into the README
...
Add link into the README from the docs
2020-02-17 17:21:22 +11:00
Angus Gratton
e753c1b509
docs: Edit out some unnecessary instances of "ESP32" in the doc text
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs
2020-02-07 16:37:43 +11:00
Ivan Grokhotkov
036a29bb3d
docs: update build system guide on setting IDF_TARGET
2020-01-31 10:19:44 +01:00
KonstantinKondrashov
b49a657448
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig
2020-01-15 11:02:27 +00:00
Angus Gratton
e1833fa3de
docs: Add example of using IDF APIs from an external CMake library
2020-01-09 13:51:30 +11:00
Renz Christian Bagaporo
91b421c35f
cmake: implement utility to import prebuilt libraries
2019-12-10 19:22:25 +08:00
Roland Dobai
105267d537
Doc: Remove menuconfig tool which is not used anymore
2019-11-28 10:07:49 +01:00
Sergei Silnov
87c979ae09
docs: add idf.py fallback commands and subcommand options
2019-11-20 12:23:03 +01:00
Renz Christian Bagaporo
d43cc4fa4b
cmake: allow multiple sdkconfig defaults to be specified
2019-11-03 16:43:58 +08:00
Renz Christian Bagaporo
d44e3d9f56
docs: cmake docs fixes
2019-10-18 12:51:46 +08:00
David Cermak
5cde268cce
docs: fix minor parameter description inconsistency for idf_component_set_property
2019-09-26 10:51:04 +02:00
Angus Gratton
96b96ae244
Merge branch 'bugfix/cmake_component_names' into 'master'
...
CMake: Component name related bugfixes
See merge request espressif/esp-idf!5921
2019-09-17 11:16:25 +08:00