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

docs: Document SpinLock and RWLock #138

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

Zildj1an
Copy link
Contributor

Document locking support. This is related to issue #74 Document COCONUT-SVSM.

@Zildj1an Zildj1an force-pushed the document_locking branch 4 times, most recently from 5ff77b1 to 8c21ba8 Compare October 19, 2023 15:31
Copy link
Member

@00xc 00xc left a comment

Choose a reason for hiding this comment

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

Looks good, just a few notes:

  • When mentioning a type (e.g. RWLock, WriteLockGuard) I'd add a link to the type with square brackets.
  • I'd avoid documenting trait implementations unless something counterintuitive is going on, as the docs for the trait itself should suffice. The generated docs already include links to the Rust core library documentation.
  • This is just a preference, but I'd hide imports in doctests with # to clean the generated docs.

@joergroedel
Copy link
Member

Looks good, just a few notes:

  • When mentioning a type (e.g. RWLock, WriteLockGuard) I'd add a link to the type with square brackets.
  • I'd avoid documenting trait implementations unless something counterintuitive is going on, as the docs for the trait itself should suffice. The generated docs already include links to the Rust core library documentation.
  • This is just a preference, but I'd hide imports in doctests with # to clean the generated docs.

Given these discussions it would be helpful if you two can come up with a documentation style document. For the virtual memory code the doc domments look quite different and some common guidelines will help to better align the style.

@Zildj1an
Copy link
Contributor Author

I have applied your feedback @00xc -- except for hiding imports, because I personally prefer seeing them; we can discuss this while preparing guidelines as @joergroedel suggested.

src/locking/rwlock.rs Outdated Show resolved Hide resolved
src/locking/spinlock.rs Outdated Show resolved Hide resolved
src/locking/spinlock.rs Outdated Show resolved Hide resolved
src/locking/spinlock.rs Outdated Show resolved Hide resolved
Document locking support. This is related to issue coconut-svsm#74 Document
COCONUT-SVSM.

Signed-off-by: Carlos Bilbao <[email protected]>
@Zildj1an
Copy link
Contributor Author

Thanks @00xc I applied the feedback

@joergroedel joergroedel merged commit 5fdabd7 into coconut-svsm:main Nov 20, 2023
2 checks passed
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.

3 participants