Conversation

phip1611

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

Partially covers #1639

Checklist

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

@phip1611phip1611 self-assigned this Apr 7, 2025
@phip1611

This comment was marked as outdated.

Sign in to view
@phip1611phip1611 mentioned this pull request Apr 7, 2025
Closed
15 tasks
@seijikun

This comment was marked as outdated.

Sign in to view
@phip1611phip1611 removed the request for review from nicholasbishop April 7, 2025 15:21
@phip1611phip1611 marked this pull request as draft April 7, 2025 15:21
@phip1611phip1611 marked this pull request as ready for review April 8, 2025 07:30
@phip1611phip1611 changed the title doc/uefi: improve device path documentation doc/uefi: improve Protocol and Device Path documentation Apr 8, 2025
@phip1611phip1611 force-pushed the doc-devicepath branch 2 times, most recently from 3213ebd to 999927a Compare April 8, 2025 07:34
phip1611
phip1611 commented Apr 8, 2025
View reviewed changes
@phip1611phip1611 force-pushed the doc-devicepath branch 2 times, most recently from 16cd39b to 5149e63 Compare April 9, 2025 10:56
@phip1611phip1611 mentioned this pull request Apr 19, 2025
Closed
@phip1611phip1611 changed the title doc/uefi: improve Protocol and Device Path documentation doc/uefi: improve Protocol documentation Apr 19, 2025
@phip1611phip1611 mentioned this pull request Apr 19, 2025
Merged
2 tasks
@phip1611phip1611 mentioned this pull request May 5, 2025
Open
10 tasks
@phip1611phip1611 force-pushed the doc-devicepath branch 5 times, most recently from 3d26ff6 to 583debc Compare May 19, 2025 19:42
@phip1611

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

@phip1611

Are we good to go here, @nicholasbishop ?

@phip1611
uefi/raw: streamline documentation of Protocol
32d121a
We don't deduplicate everything and keep a few important things
in uefi as well. See #1641 (comment) for a discussion.
@phip1611
uefi: streamline documentation of Protocol structs
ac57827
Now each struct's documentation begins with "$ProtocolName [`Protocol`]". This
way, readers quickly can figure out what Protocols are in general.
@phip1611
uefi: doc: link to Protocol type in more places
e312a6b
@phip1611
book: improve chapter "Using Protocols"
0179447
@phip1611
doc: changelog update
4e03942
@nicholasbishopnicholasbishop added this pull request to the merge queue Jun 19, 2025
Merged via the queue into main with commit 5d233a5 Jun 19, 2025
20 checks passed
@nicholasbishopnicholasbishop deleted the doc-devicepath branch June 19, 2025 17:32
Sign up for free to join this conversation on . Already have an account? Sign in to comment

@nicholasbishop nicholasbishop nicholasbishop approved these changes

@phip1611 phip1611

None yet
None yet
No milestone

Successfully merging this pull request may close these issues.