doc: _scripts: gen_devicetree_rest: add link to driver sources #79259
+73
−6
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
kartben
force-pushed
the
bindings_page_driver_link
branch
from
c39d482
to
806665f
Compare
kartben
force-pushed
the
bindings_page_driver_link
branch
from
806665f
to
9c68380
Compare
pdgendt
reviewed
Oct 1, 2024
When generating the documentation pages for the devicetree bindings, add a link to the .c file implementing the corresponding driver, or folder likely to contain the driver implementation, using heuristics to determine the most likely location of the driver sources. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
bindings_page_driver_link
branch
from
9c68380
to
2339ffb
Compare
|
Addressed @pdgendt's comment and switched to using a slightly less intrusive "note admonition". See screenshot in the initial comment. |
pdgendt
approved these changes
Oct 1, 2024
kartben
requested review from
fgrandel,
fabiobaltieri,
henrikbrixandersen,
Thalley and
ajarmouni-st
Thalley
approved these changes
Oct 1, 2024
fabiobaltieri
approved these changes
Oct 1, 2024
fgrandel
approved these changes
Oct 2, 2024
|
@erwango fyi as I know this is a topic that's typically of interest to you :) |
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.
When generating the documentation pages for the devicetree bindings, add a link to the .c file implementing the corresponding driver, or folder likely to contain the driver implementation, using heuristics to determine the most likely location of the driver sources. There's probably a few edge cases of drivers that aren't properly "guessed", but for the wide majority of bindings, this significantly improves the user experience when it comes to being able to quickly find the source code of the driver matching a given compatible.
As CI is running in "DT turbo mode" and hence not generating the docs for the DT bindings, you may check the result of this PR over at: https://builds.zephyrproject.io/zephyr/pr/79259-alt/html/build/dts/api/bindings.html