Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

doc: streamline device path documentation between uefi-raw and uefi#1641

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
nicholasbishop merged 2 commits intomainfromdoc-devicepath-v2
May 19, 2025

Conversation

phip1611
Copy link
Member

@phip1611phip1611 commentedApr 19, 2025
edited
Loading

Closes#1639. I personally prefer to move all generic low-level UEFI documentation touefi-raw and 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

  • Sensible git history (for example, squash "typo" or "fix" commits). See theRewriting History guide for help.
  • Update the changelog (if necessary)

@phip1611phip1611force-pushed thedoc-devicepath-v2 branch 2 times, most recently from24709c7 to5522012CompareApril 19, 2025 15:12
@phip1611phip1611 changed the titledoc: stream documentation for device-paths between uefi-raw and uefidoc: streamline device path documentation between uefi-raw and uefiApr 19, 2025
//! ├─── DevicePathInstance ────╨────── DevicePathInstance ─────┤
//! │ │
//! └─────────────────── Entire DevicePath ─────────────────────┘
//! ```

Choose a reason for hiding this comment

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

I'd like to keep this more detailed documentation inuefi, even if it's also duplicated inuefi-raw. I think users shouldn't normally have to look atuefi-raw unless they're doing something advanced.

Copy link
MemberAuthor

@phip1611phip1611Apr 19, 2025
edited
Loading

Choose a reason for hiding this comment

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

I don't have a strong opinion, but I like consistency. In#1612 I also put the main documentation intouefi-raw and just forward to it fromuefi.

When in doubt, I think I prefer some overlap , as long asuefi-raw holds the majority of the low-level documentation details

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Updated. Do you like the new version better?

phip1611 added a commit that referenced this pull requestApr 21, 2025
The idea is that people should not always read the uefi-raw docin any case. Therefore, a briefly simplified version of the uefi-rawdoc is now also in uefi.See#1641 (comment)for a discussion.
@phip1611phip1611 mentioned this pull requestApr 21, 2025
15 tasks
phip1611 added a commit that referenced this pull requestApr 21, 2025
The idea is that people should not always read the uefi-raw docin any case. Therefore, a briefly simplified version of the uefi-rawdoc is now also in uefi.See#1641 (comment)for a discussion.
phip1611 added a commit that referenced this pull requestApr 21, 2025
The idea is that people should not always read the uefi-raw docin any case. Therefore, a briefly simplified version of the uefi-rawdoc is now also in uefi.See#1641 (comment)for a discussion.
phip1611 added a commit that referenced this pull requestApr 21, 2025
The idea is that people should not always read the uefi-raw docin any case. Therefore, a briefly simplified version of the uefi-rawdoc is now also in uefi.See#1641 (comment)for a discussion.
@phip1611phip1611 mentioned this pull requestMay 5, 2025
10 tasks
The idea is that people should not always read the uefi-raw docin any case. Therefore, a briefly simplified version of the uefi-rawdoc is now also in uefi.See#1641 (comment)for a discussion.
@nicholasbishopnicholasbishop added this pull request to themerge queueMay 19, 2025
Merged via the queue intomain with commit9b9e621May 19, 2025
20 checks passed
@nicholasbishopnicholasbishop deleted the doc-devicepath-v2 branchMay 19, 2025 18:08
phip1611 added a commit that referenced this pull requestMay 19, 2025
We don't deduplicate everything and keep a few important thingsin uefi as well. See#1641 (comment) for a discussion.
phip1611 added a commit that referenced this pull requestMay 31, 2025
We don't deduplicate everything and keep a few important thingsin uefi as well. See#1641 (comment) for a discussion.
phip1611 added a commit that referenced this pull requestJun 10, 2025
We don't deduplicate everything and keep a few important thingsin uefi as well. See#1641 (comment) for a discussion.
tmvkrpxl0 pushed a commit to tmvkrpxl0/uefi-rs that referenced this pull requestJun 30, 2025
We don't deduplicate everything and keep a few important thingsin uefi as well. Seerust-osdev#1641 (comment) for a discussion.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@nicholasbishopnicholasbishopnicholasbishop approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: streamline device path doc betweenuefi anduefi-raw
2 participants
@phip1611@nicholasbishop

[8]ページ先頭

©2009-2025 Movatter.jp