Add documentation for Rust support #83715
Draft
+185
−1
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
|
The following west manifest projects have changed revision in this Pull Request:
Additional metadata changed:
⛔ DNM label due to: 1 project with metadata changes Note: This message is automatically posted and updated by the Manifest GitHub Action. |
zephyrbot
added
manifest
manifest-zephyr-lang-rust
DNM
d3zd3z
force-pushed
the
r/docs-2025-01-08
branch
26 times, most recently
from
89e25b8 to
45860a3
Compare
d3zd3z
force-pushed
the
r/docs-2025-01-08
branch
2 times, most recently
from
56c3f29 to
c60aaf1
Compare
Move to the latest version:
commit f82407c13059528e88bfcc892a488504e9caa80c
Author: David Brown <[email protected]>
Date: Thu Jan 16 17:05:59 2025 -0700
This brings in numerous features to the rust support including:
- Simple logging through Zephyr's logging
- Mutex/Condvar (k_mutex, k_condvar), Semaphores (k_sem), and Queue
(k_queue)
- A rust interface to timers, both waiting for events and callback based
- A SpinMutex that protects data in a rust safe way using a spinlock
- Some documentation for the rust support. Documentation is generated,
per-pr, on the module to allow preview
- A dining philosopher sample that implements using several different
mechanism.
- Basic device support. The device tree is imported into Rust, with a
yaml file describing the association between DT nodes and devices.
- Basic interface to GPIO and flash devices.
Signed-off-by: David Brown <[email protected]>
Create an initial document describing how to get started a Rust application on Zephyr. Signed-off-by: David Brown <[email protected]>
This adds a job that builds the rustdoc documentation. Signed-off-by: David Brown <[email protected]>
d3zd3z
force-pushed
the
r/docs-2025-01-08
branch
from
c60aaf1 to
56dda2d
Compare
Include the generated Rust documentation in the published docs, both for PR and for main, if they were generated. Signed-off-by: David Brown <[email protected]>
d3zd3z
force-pushed
the
r/docs-2025-01-08
branch
from
56dda2d to
19e46e6
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.
This brings in some basic documentation for Rust support, as well as adding workflow support to build the rust docs as part of CI.