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

Already on GitHub?Sign in to your account

Merged
nicholasbishop merged 5 commits intomainfromdoc-devicepath
Jun 19, 2025
Merged

Conversation

phip1611
Copy link
Member

@phip1611phip1611 commentedApr 7, 2025•
edited
Loading

Improve Protocol documentation in general.The idea here is to centralize all documentation inuefi-raw and then forward to it from UEFI. The idea is thatuefi-raw contains no less technical information thanuefi

Partially covers#1639

Checklist

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

@phip1611phip1611 self-assigned thisApr 7, 2025
@phip1611

This comment was marked as outdated.

@phip1611phip1611 mentioned this pull requestApr 7, 2025
15 tasks
@seijikun

This comment was marked as outdated.

@phip1611phip1611 removed the request for review fromnicholasbishopApril 7, 2025 15:21
@phip1611phip1611 marked this pull request as draftApril 7, 2025 15:21
@phip1611phip1611 marked this pull request as ready for reviewApril 8, 2025 07:30
@phip1611phip1611 changed the titledoc/uefi: improve device path documentationdoc/uefi: improve Protocol and Device Path documentationApr 8, 2025
@phip1611phip1611force-pushed thedoc-devicepath branch 2 times, most recently from3213ebd to999927aCompareApril 8, 2025 07:34
@phip1611phip1611force-pushed thedoc-devicepath branch 2 times, most recently from16cd39b to5149e63CompareApril 9, 2025 10:56
@phip1611phip1611 changed the titledoc/uefi: improve Protocol and Device Path documentationdoc/uefi: improve Protocol documentationApr 19, 2025
@phip1611phip1611 mentioned this pull requestMay 5, 2025
10 tasks
@phip1611phip1611force-pushed thedoc-devicepath branch 5 times, most recently from3d26ff6 to583debcCompareMay 19, 2025 19:42
@phip1611
Copy link
MemberAuthor

phip1611 commentedMay 19, 2025•
edited
Loading

I rebased everything and I think it is ready now. IMHO, this improves the "What is a protocol?" question for newbies inuefi a lot@nicholasbishop

@phip1611
Copy link
MemberAuthor

Are we good to go here,@nicholasbishop ?

We don't deduplicate everything and keep a few important thingsin uefi as well. See#1641 (comment) for a discussion.
Now each struct's documentation begins with "$ProtocolName [`Protocol`]". Thisway, readers quickly can figure out what Protocols are in general.
@nicholasbishopnicholasbishop added this pull request to themerge queueJun 19, 2025
Merged via the queue intomain with commit5d233a5Jun 19, 2025
20 checks passed
@nicholasbishopnicholasbishop deleted the doc-devicepath branchJune 19, 2025 17:32
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@nicholasbishopnicholasbishopnicholasbishop approved these changes

Assignees

@phip1611phip1611

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@phip1611@seijikun@nicholasbishop
[8]ページ先頭
©2009-2025 Movatter.jp