Document the package resource index (PRI) file format - #6105
Draft
John Kennedy (GrantMeStrength) with Copilot wants to merge 2 commits into
Draft
Document the package resource index (PRI) file format#6105John Kennedy (GrantMeStrength) with Copilot wants to merge 2 commits into
John Kennedy (GrantMeStrength) with Copilot wants to merge 2 commits into
Conversation
Co-authored-by: GrantMeStrength <1928855+GrantMeStrength@users.noreply.github.com>
Contributor
|
Learn Build status updates of commit 0763d1a:
|
Copilot
AI
changed the title
[WIP] Add documentation for the PRI file format
Document the package resource index (PRI) file format
Aug 31, 2026
Contributor
|
Learn Build status updates of commit 3e61fec: 💡 Validation status: suggestions
uwp/app-resources/pri-file-format.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
Contributor
PRMerger Results
|
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
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.
The PRI file format was undocumented — existing content covers the tools that produce PRI files (MakePri.exe, the PRI APIs) but never describes what a PRI file actually contains. This adds an article covering the logical structure and how to inspect one.
New article:
uwp/app-resources/pri-file-format.mdresources.priat the package root, additional PRI files per resource package, and why the format is data-only rather than PE.makepri dumpXML sample and a table mapping each element to its run-time projection (ResourceMap,NamedResource,ResourceCandidate).emitStrings/emitPaths/emitEmbeddedDataattributes of thepriinfoindexer./SchemaFile(sf)), and the debugging-only reverse map from/ReverseMap(rm).makepri dumpwith the four dump types plus/ooand/es,MrmDumpPriFile, and run-time enumeration viaResourceManageror MRT Core.Scope of what is claimed
The byte-level layout is deliberately not described. Rather than reverse-engineering or inventing a specification, an
[!IMPORTANT]note states plainly that the binary layout is undocumented, is not a stable contract, may change across Windows/SDK versions, and that code should not parse PRI bytes directly. Everything documented is the logical structure that supported tools and APIs already expose, sourced from existing repo content (MakePri options/config/indexers, PRI APIs scenario 1, Resource Management System) — no new property, API, or version names are introduced.Discoverability
uwp/develop/toc.yml, positioned before the MakePri.exe entries.Reviewers may want to weigh in on whether
Summarydump type is described accurately —makepri dump /?does not define it, so the description is inferred from the observed output summary format and is the one claim worth a second look.