Skip to content
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

Documentation: Add Rust integration guide for NuttX #15476

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

no1wudi
Copy link
Contributor

@no1wudi no1wudi commented Jan 9, 2025

Summary

Add a new guide documenting how to integrate Rust with NuttX, including:

  • Prerequisites and supported platforms
  • Setup instructions for Rust toolchain
  • Required NuttX configurations
  • Example build and run instructions for RISCV32 target

The guide provides an experimental but working example of running
a Rust application on NuttX using the rv-virt:nsh board.

Impact

New doc

Testing

GitHub CI

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Jan 9, 2025
@no1wudi no1wudi force-pushed the doc branch 2 times, most recently from e126092 to 7baa86a Compare January 9, 2025 02:51
@no1wudi no1wudi marked this pull request as draft January 9, 2025 02:54
@nuttxpr
Copy link

nuttxpr commented Jan 9, 2025

[Experimental Bot, please feedback here]

No. The PR, as described, lacks several key pieces of information required by the NuttX guidelines.

  • Insufficient Testing Detail: "GitHub CI" is not enough. The guidelines specifically request logs before and after the change. While CI passing is good, it doesn't replace the need for demonstrating the specific change's impact. The reviewer needs to see evidence of the expected behavior both with and without the new guide.
  • Missing Target Details: While RISCV32 is mentioned, the specific board configuration (rv-virt:nsh) should also be listed under Impact -> Impact on hardware. This makes it clear which hardware configurations are affected.
  • Missing Build Host Details: The Testing section requires details about the build host environment used for verification. OS, CPU architecture, and compiler version are all necessary.
  • Missing "Before" State: The guide is new, but the "before" logs should still reflect the attempt to build and run a Rust application without the guide. This demonstrates the current state and highlights the problem the guide solves.
  • Clarity on "Experimental": While mentioning "experimental" is helpful, the PR should elaborate on what aspects are experimental and any limitations or known issues. This helps manage expectations.

The PR author needs to provide these missing details to meet the NuttX requirements fully.

Add a new guide documenting how to integrate Rust with NuttX, including:
- Prerequisites and supported platforms
- Setup instructions for Rust toolchain
- Required NuttX configurations
- Example build and run instructions for RISCV32 target

The guide provides an experimental but working example of running
a Rust application on NuttX using the rv-virt:nsh board.

Signed-off-by: Huang Qi <[email protected]>
@no1wudi no1wudi marked this pull request as ready for review January 9, 2025 06:44
@xiaoxiang781216 xiaoxiang781216 merged commit a8ba833 into apache:master Jan 9, 2025
3 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants