doc/configuration: update/fix bindings, protocols and resource usage #1322
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1322 +/- ##
========================================
- Coverage 62.8% 62.8% -0.1%
========================================
Files 163 163
Lines 12019 12019
========================================
- Hits 7550 7549 -1
- Misses 4469 4470 +1 ☔ View full report in Codecov by Sentry. |
Bastian-Krause
force-pushed
the
bst/doc-update
branch
from
57fac01 to
6158356
Compare
|
CI fails due to #1327. |
This fixes list rendering. Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Other network resourced do not list the drivers using them, neither. Signed-off-by: Bastian Krause <bst@pengutronix.de>
Initially, all driver bindings were documented with their respective binding key. This wasn't documented consistently since then. Especially when using multiple instances of a single driver class, the bindings are needed to specify on which resource or other driver the driver should bind on. Until now, most binding keys had to be looked up in the source code. So improve this situation by fixing and adding binding keys as well as also adding all Remote/Network resource variants a driver is able to bind to. Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Explicitly quote string top prevent strange yaml string auto dection issues. Also use better readable dict notation everywhere. Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
…yaml snippet In the previous form, it looks like the environemnt's "drivers" section also contains the "images" section, which is not the case. Make that clear by splitting both sections into their own snippet. Signed-off-by: Bastian Krause <bst@pengutronix.de>
…busRTUDriver Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Bastian-Krause
force-pushed
the
bst/doc-update
branch
from
6158356 to
9e43814
Compare
|
Rebased on current master. |
Emantor
approved these changes
Mar 14, 2024
Bastian-Krause
merged commit be28ac1
into
labgrid-project:master
10 of 11 checks passed
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
Initially, all driver bindings were documented with their respective binding key. This wasn't documented consistently since then.
Especially when using multiple instances of a single driver class, the bindings are needed to specify on which resource or other driver a driver should bind on. Until now, most binding keys had to be looked up in the source code. So improve this situation by fixing and adding binding keys as well as also adding all Remote/Network resource variants a driver is able to bind to.
Also update protocol implementations and resource usage. While at it, document drivers not expecting arguments, drop driver usage from network resouces, fix header underlines and remove unnecessary new lines.
Checklist