doc: dts: Fix outdated identifier list for /chosen and improve related docs #21594
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
ulfalizer
force-pushed
the
fix-chosen-docs
branch
from
77156b3 to
5f30002
Compare
dbkinder
suggested changes
Dec 29, 2019
doc/guides/dts/index.rst
Outdated
| default "" if HAS_DTS | ||
|
|
||
| To see how the preprocessor is used for a symbol, look it up directly in the | ||
| :file:`Kconfig` file where it is defined instead. The referenc page for the |
There was a problem hiding this comment.
fix misspelling of reference
ulfalizer
force-pushed
the
fix-chosen-docs
branch
from
5f30002 to
e9378ca
Compare
dbkinder
approved these changes
Dec 30, 2019
ulfalizer
force-pushed
the
fix-chosen-docs
branch
2 times, most recently
from
ecac5c4 to
05745eb
Compare
The *_ON_DEV_NAME macros generated from /chosen properties changed prefix from DT_* to CONFIG_* in commit 8ce0cf0 ("kconfig: Convert device tree chosen properties to new kconfigfunctions"), but the devicetree documentation still lists the old names. Update the documentation with the correct anmes. Also remove an outdated reference to DT_SRAM_SIZE/DT_SRAM_BASE_REFERENCE, and give a complete list of generated macros. Signed-off-by: Ulf Magnusson <[email protected]>
Not all /chosen properties were documented. Add the missing ones along with the macros generated for them. Found with some grepping for '\<zephyr,.*='. Signed-off-by: Ulf Magnusson <[email protected]>
It's cryptic that some identifiers for devicetree-related stuff start with DT_*, while others start with CONFIG_*. Explain what's going on, and link to the Kconfig preprocessor documentation. Also remove an early mention of bindings that might be confusing. Bindings are much more about checking devicetree conformance than about controlling output, though they do some of that too. Signed-off-by: Ulf Magnusson <[email protected]>
Turn the CONFIG_* identifiers in the /chosen table into links to the Kconfig reference. Also explain why devicetree information doesn't show up in the Kconfig reference. Signed-off-by: Ulf Magnusson <[email protected]>
ulfalizer
force-pushed
the
fix-chosen-docs
branch
from
05745eb to
833ac39
Compare
carlescufi
approved these changes
Jan 9, 2020
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.
Updating the list of identifiers generated for
/chosenwas overlooked after commit 8ce0cf0 ("kconfig: Convert device tree chosen properties to new kconfigfunctions"). Update the list, and also add some missing documentation.Commits: