[esp32] Document github:// framework source for native ESP-IDF#6691
Open
swoboda1337 wants to merge 6 commits into
Open
[esp32] Document github:// framework source for native ESP-IDF#6691swoboda1337 wants to merge 6 commits into
swoboda1337 wants to merge 6 commits into
Conversation
Merged
18 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Documents additional esp32.framework.source formats for the ESP32 component so users of the native ESP-IDF toolchain can point at GitHub repositories (with submodules) when using custom/pre-release ESP-IDF versions.
Changes:
- Rewords
framework.sourceto describe it as a toolchain-dependent “framework source override”. - Keeps PlatformIO package-spec examples for the PlatformIO toolchain path.
- Adds native ESP-IDF toolchain documentation for
github://owner/repo[@ref]andhttps://github.com/owner/repo.git[@ref]sources, including an example.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the new
framework.sourceforms accepted by the native ESP-IDF toolchain:github://owner/repo[@ref]https://github.com/owner/repo.git[@ref]These trigger a
git clone --recurse-submodulesinstead of an archive download. Required when using a custom IDF (e.g. `master` for chips not yet in a tagged release) because GitHub's archive URLs strip submodules and the build fails.The existing PlatformIO source examples are kept for the PlatformIO toolchain path.
Related issue (if applicable): N/A
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into `next` because this is new documentation that has a matching pull-request in esphome as linked above.
or
I am merging into `current` because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
Link added in `/src/content/docs/components/index.mdx` when creating new documents for new components or cookbook.