Add defaults scraping to settings docs updater #6406
Merged
Conversation
This file contains 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
nmaggioni
force-pushed
the
nm_settings_md_check_defaults
branch
from
9c8ce6f
to
688485e
Compare
nmaggioni
added a commit
to nmaggioni/inav
that referenced
this pull request
Mar 31, 2021
nmaggioni
force-pushed
the
nm_settings_md_check_defaults
branch
from
01f0ff7
to
acabefe
Compare
nmaggioni
force-pushed
the
nm_settings_md_check_defaults
branch
from
d5ee1d6
to
0db0725
Compare
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.
Some default values in the settings' YAML spec didn't match the actual values in the code. This PR updates them and adds a new
{-d,--defaults}option to the updater script to check for such mismatches.Since this check is done by scraping the C sources it's not effective when default values aren't directly referenced in their page reset structs, but it's better than nothing. Exact matches would require far more complex parsing strategies.
If this proves to be useful it could be added to the docs' CI workflow.
As of 01f0ff7, this PR brings docs compatibility with #6595.