[esphome] Document esphome.build_flags option#6689
Open
swoboda1337 wants to merge 2 commits into
Open
Conversation
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
Adds documentation for the new top-level esphome.build_flags option, clarifying how it differs from the existing PlatformIO-only esphome.platformio_options.build_flags and how flags are handled across build backends.
Changes:
- Documented the new
esphome.build_flagsadvanced option in the configuration variable list. - Added a dedicated
build_flagssection with example YAML and backend-specific behavior notes.
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 top-level `esphome.build_flags` option, which adds extra compiler flags to the build and works on both the PlatformIO and native ESP-IDF backends. Complements (and does not replace) the existing PlatformIO-only `esphome.platformio_options.build_flags`.
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.