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

Improve API clarity and docs #207

Merged
merged 18 commits into from
Oct 7, 2024
Merged

Conversation

nspin
Copy link
Member

@nspin nspin commented Oct 7, 2024

This PR contains a few minor API changes (mostly method renames), for the sake of clarity. Most importantly:

AbsoluteCPtr:

  • relative -> absolute_cptr
  • relative_bits_with_depth -> absolute_cptr_from_bits_with_depth
  • relative_self -> absolute_cptr_for_self

Other than that, it improves and expands rustdoc for the sel4 and sel4-root-task crates, along with a few others.

Signed-off-by: Nick Spinale <[email protected]>
Signed-off-by: Nick Spinale <[email protected]>
Signed-off-by: Nick Spinale <[email protected]>
Rename *relative_cptr* -> *absolute_cptr*

Signed-off-by: Nick Spinale <[email protected]>
Signed-off-by: Nick Spinale <[email protected]>
Signed-off-by: Nick Spinale <[email protected]>
@nspin nspin force-pushed the pr/improve-clarity-and-docs branch from 84f9329 to 774815b Compare October 7, 2024 05:42
@nspin nspin merged commit 2312360 into seL4:main Oct 7, 2024
9 checks passed
@nspin nspin deleted the pr/improve-clarity-and-docs branch October 7, 2024 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant