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.
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.
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
[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
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
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
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.
