-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: enhance Rust guide #15754
Open
no1wudi
wants to merge
2
commits into
apache:master
Choose a base branch
from
no1wudi:doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docs: enhance Rust guide #15754
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
Summary: - Updated the Rust guide documentation to include X86 and X86_64 platforms in the supported platforms list. - Ensured that the guide provides accurate and up-to-date information for developers using these new platforms. Impact: - Expands the platform support section of the Rust guide, making it more inclusive and useful for a wider range of developers. - No functional changes to the code itself; this update only affects the documentation. - Enhances the usability of the guide by providing necessary setup and configuration details for the X86 and X86_64 architectures. Signed-off-by: Huang Qi <[email protected]>
Summary: - Added a section to the Rust guide that explains how to use the `RUSTFLAGS` environment variable to specify the target CPU for optimization. - Provides examples and instructions for setting `RUSTFLAGS` for different CPU models, such as Cortex-M33 and Cortex-M55, to generate performance-optimized code. Impact: - Enhances the developer's ability to produce more efficient Rust applications on NuttX by leveraging CPU-specific optimizations. - No runtime or functional changes; only documentation improvements to guide users in optimizing their build configurations for specific hardware. Signed-off-by: Huang Qi <[email protected]>
[Experimental Bot, please feedback here] Yes, this PR appears to meet the NuttX requirements, although it could be slightly improved. Here's a breakdown: Strengths:
Areas for Improvement:
Conclusion: The PR is generally well-structured and meets the core requirements. Addressing the minor improvements mentioned above would make it even stronger and easier to review. |
linguini1
approved these changes
Feb 4, 2025
simbit18
approved these changes
Feb 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Area: Documentation
Improvements or additions to documentation
Size: S
The size of the change in this PR is small
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.
docs: enhance Rust guide with CPU optimization instructions
Summary
RUSTFLAGS
environment variable to specify the target CPU for optimization.RUSTFLAGS
for different CPU models, such as Cortex-M33 and Cortex-M55, to generate performance-optimized code.Impact
Test
local document build