If possible, periodically update the project to a new major or minor ESP-IDF version (for example, once a year.) The update process should be straightforward for Minor updates, but may require some planning and checking of the release notes for Major updates.Īlways plan to update to a newer release before the release you are using becomes End of Life.Įach ESP-IDF major and minor release (V4.1, V4.2, etc) is supported for 30 months after the initial stable release date. Whenever a bug fix release is available for the version you are using, plan to update to it. GitHub will notify you whenever a new release is available. If you have a GitHub account, click the “Watch” button in the top-right of the Releases page and choose “Releases only”. If starting a new project, use the latest stable release. The ESP-IDF Support Period Policy explains this in detail, and describes how the support periods for each release are determined.Įach release on the Releases page includes information about the support period for that particular release. After this period, the release is End of Life and no longer supported. If updating to a new bugfix release (for example, from v3.0 to v3.0.1), you do not need to change any code in your project, and you only need to re-test the functionality directly related to bugs listed in the release notes on the Releases page.Įach ESP-IDF major and minor release version has an associated support period. Pay particular attention to the items mentioned in the release notes on the Releases page.īugfix Releases like v3.0.1 only fix bugs and do not add new functionality. If updating to a new minor release (for example, from v3.0 to v3.1), your project’s code does not require updating, but you should re-test your project. Minor Releases like v3.1 add new functionality and fix bugs but will not change or remove documented functionality, or make incompatible changes to public APIs. ![]() The release notes on the Releases page include lists of Breaking Changes to refer to. If updating to a new major release (for example, from v2.1 to v3.0), some of your project’s code may need updating and functionality may need to be re-tested. This includes removing deprecated functionality. ![]() Major Releases, like v3.0, add new functionality and may change functionality. Versioning Scheme ĮSP-IDF uses Semantic Versioning. See Updating ESP-IDF if you already have a local copy of ESP-IDF and wish to update it. If you plan to use another project which is based on ESP-IDF, please check the documentation of that project to determine the version(s) of ESP-IDF it is compatible with. It is recommended to start from a stable version and then follow the instructions for Updating to a Pre-Release Version or Updating to a Release Branch. If a required feature is not yet available in a stable release, but you do not want to use the master branch, it is possible to check out a pre-release version or a release branch. The latest version in the master branch has all the latest features and has passed automated testing, but has not been completely manually tested (“bleeding edge”). Also refer to Compatibility Between ESP-IDF Releases and Revisions of Espressif SoCs to make sure the ESP-IDF version you selected is compatible with the chip revision you are going to produce with.įor prototyping, experimentation or for developing new ESP-IDF features, use the latest version (master branch in Git). ![]() Every stable release version can be found on the Releases page. Stable versions have been manually tested, and are updated with “bugfix releases” which fix bugs without changing other functionality (see Versioning Scheme for more details). You can also use this dropdown to switch between versions of the documentation.ĭocumentation for older versions are also still available: Which Version Should I Start With? įor production purposes, use the current stable version. There you can find release notes, links to each version of the documentation, and instructions for obtaining each version.Īnother place to find documentation for all current releases is the documentation page, where you can go to the upper-left corner and click the version dropdown (between the target dropdown and the search bar). The full history of releases can be found on the GitHub repository Releases page. The documentation for the current stable release version can always be found at this URL:ĭocumentation for the latest version (master branch) can always be found at this URL: The ESP-IDF GitHub repository is updated regularly, especially the master branch where new development takes place.įor production use, there are also stable releases available.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |