edtlib: binding: Add a examples keyword #98630
Draft
+94 −1
Conversation
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
Add an `examples` keyword to the binding to provide a minimal example node for the binding. Signed-off-by: James Roy <rruuaanng@outlook.com>
rruuaanng force-pushed the add-examples-key branch from 989a893 to f2769e4 Compare 
|
| You should stick to the original way where |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
https://github.com/torvalds/linux/blob/master/Documentation/devicetree/bindings/cpufreq/qcom-cpufreq-nvmem.yaml
Currently, we put example nodes directly in the
description, which can make the description very long, especially for complex bindings.The upstream examples keyword looks promising, as it separates example nodes from the description.
We can access the example through
Binding.exampleinedtlib, which may also be beneficial for future documentation work.