-
-
Notifications
You must be signed in to change notification settings - Fork 169
doc/uefi: improve Protocol and Device Path documentation #1612
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
base: main
Are you sure you want to change the base?
Conversation
Hey @seijikun, |
I don't remember in full detail, but: One thing I happend to "stumble" over while developing was, implementing the fn deref(&self) -> &Self::Target {
unsafe { DevicePathNode::from_ffi_ptr(self.0.as_ptr().as_ptr().cast()) }
} So it took me a while to understand how the API was meant to be used and what the relationship between But I think that's mostly interna - so not very interesting for users of Personally, I mostly use |
3213ebd
to
999927a
Compare
//! another. | ||
//! | ||
//! Implementation-wise, a protocol is a `C` struct holding function pointers | ||
//! and/or data. Please note that some protocols may use [`core::ptr::null`] as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nicholasbishop I'd like to add more about protocol interfaces being null; why can they be null and when is this valid? Can you help?
Better explain what protocols are.
Now each struct's documentation begins with "$ProtocolName [`Protocol`]". This way, readers quickly can figure out what Protocols are in general.
Make the role of the high-level DevicePath wrapper more clear.
Checklist