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

uapi: documentation for the uapi crate #65

Merged
merged 8 commits into from
Oct 7, 2024

Conversation

pthierry-ledger
Copy link
Member

@pthierry-ledger pthierry-ledger commented Oct 2, 2024

Add clean documentation for UAPI crate

  • add ::uapi module interface documentation
  • add module level documentation for all modules
  • add ::syscall module interface documentation
  • add ::svc_exchange interface documentation
  • add ::systypes module itnerface documentation

@pthierry-ledger pthierry-ledger added documentation Improvements or additions to documentation api impact the external API of the component labels Oct 2, 2024
@pthierry-ledger pthierry-ledger added this to the Sentry-v0.3.0 milestone Oct 2, 2024
@pthierry-ledger pthierry-ledger force-pushed the uapi-rust-doc branch 3 times, most recently from 3cedb15 to b9bf4ed Compare October 2, 2024 12:48
@pthierry-ledger pthierry-ledger force-pushed the uapi-rust-doc branch 3 times, most recently from 3cb4b16 to af5a8d0 Compare October 4, 2024 13:26
@@ -3,7 +3,9 @@

use crate::systypes::{EraseMode, EraseType, Status};

/// SVC Exchange area len. TODO: to be kconfig-generated
pub const SVC_EXCH_AREA_LEN: usize = 128; // TODO: replace by CONFIG-defined value
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still used ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By now yes, but by nobody.... (extern C do not use this, shield-rs doesn't exist. This requires to be fixed though, but in another PR. Checking for issue

@pthierry-ledger pthierry-ledger merged commit 5a4e91a into outpost-os:main Oct 7, 2024
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api impact the external API of the component documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants