doc: streamline device path documentation between uefi-raw and uefi #1641
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phip1611
force-pushed
the
doc-devicepath-v2
branch
2 times, most recently
from
24709c7 to
5522012
Compare
phip1611
changed the title
phip1611
force-pushed
the
doc-devicepath-v2
branch
from
5522012 to
fb4e62f
Compare
| //! ├─── DevicePathInstance ────╨────── DevicePathInstance ─────┤ | ||
| //! │ │ | ||
| //! └─────────────────── Entire DevicePath ─────────────────────┘ | ||
| //! ``` |
There was a problem hiding this comment.
I'd like to keep this more detailed documentation in uefi, even if it's also duplicated in uefi-raw. I think users shouldn't normally have to look at uefi-raw unless they're doing something advanced.
There was a problem hiding this comment.
I don't have a strong opinion, but I like consistency. In #1612 I also put the main documentation into uefi-raw and just forward to it from uefi.
When in doubt, I think I prefer some overlap , as long as uefi-raw holds the majority of the low-level documentation details
There was a problem hiding this comment.
Updated. Do you like the new version better?
phip1611
added a commit
that referenced
this pull request
Apr 21, 2025
The idea is that people should not always read the uefi-raw doc in any case. Therefore, a briefly simplified version of the uefi-raw doc is now also in uefi. See #1641 (comment) for a discussion.
phip1611
added a commit
that referenced
this pull request
Apr 21, 2025
The idea is that people should not always read the uefi-raw doc in any case. Therefore, a briefly simplified version of the uefi-raw doc is now also in uefi. See #1641 (comment) for a discussion.
phip1611
force-pushed
the
doc-devicepath-v2
branch
from
4352356 to
66cb166
Compare
phip1611
added a commit
that referenced
this pull request
Apr 21, 2025
The idea is that people should not always read the uefi-raw doc in any case. Therefore, a briefly simplified version of the uefi-raw doc is now also in uefi. See #1641 (comment) for a discussion.
The idea is that people should not always read the uefi-raw doc in any case. Therefore, a briefly simplified version of the uefi-raw doc is now also in uefi. See #1641 (comment) for a discussion.
phip1611
force-pushed
the
doc-devicepath-v2
branch
from
66cb166 to
ef6a895
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1639. I personally prefer to move all generic low-level UEFI documentation to
uefi-rawand refer to it fromuefi.Together with #1612, I think this is a major step forward in our documentation, when it comes to Protocols and Device Paths.
Checklist