Skip to content

Document including the virtual registry (Registry.dat) when packaging manually#491

Open
RDMacLachlan wants to merge 2 commits into
MicrosoftDocs:mainfrom
RDMacLachlan:users/romaclac/docbug-31660799
Open

Document including the virtual registry (Registry.dat) when packaging manually#491
RDMacLachlan wants to merge 2 commits into
MicrosoftDocs:mainfrom
RDMacLachlan:users/romaclac/docbug-31660799

Conversation

@RDMacLachlan

Copy link
Copy Markdown
Collaborator

Summary

Adds an (Optional) Include registry entries (virtual registry) section to msix-src/desktop/desktop-to-uwp-manual-conversion.md, resolving this bug's request to document how to create the Registry.dat (virtual registry / "vreg") hive from scratch in a CI/CD pipeline.

The manual/command-line packaging how-to walks through the manifest, PRI, and MakeAppx, but never explains how to include registry entries. The new section documents:

  • What Registry.dat is — a registry hive at the package layout root that represents the virtual HKLM\Software, merged at runtime (cross-links to the Registry section of Understanding how packaged desktop apps run on Windows).
  • A key CI/CD factMakeAppx packages the layout as-is and does not generate Registry.dat from a .reg file, so the hive must already exist in the layout.
  • Supported ways to produce the hive: the MSIX Packaging Tool command line for unattended/CI/CD conversions (recommended), the Package Editor's Virtual registry page, and generating a hive directly with reg save.

The bug's ReproSteps asked to source the exact generation method from the MSIX Packaging Tool devs; the recommended path here points at that tooling (which captures registry into the hive automatically) rather than publishing an unverified low-level binary-hive recipe.

All four cross-links were verified to resolve (including the #registry and #virtual-registry-page anchors).

Resolves AB#31660799

… manually

Add an "(Optional) Include registry entries (virtual registry)" section to
the manual/command-line packaging how-to. It explains that a package's
virtual registry lives in a Registry.dat hive at the layout root, that
MakeAppx packs the layout as-is and does not generate the hive from a .reg
file, and the supported ways to produce it for CI/CD: the MSIX Packaging
Tool command line (recommended), the Package Editor Virtual registry page,
and generating a hive with reg save. Cross-links to the runtime registry
behavior and the relevant tooling pages.

Resolves AB#31660799

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 8b9c1b2:

✅ Validation status: passed

File Status Preview URL Details
msix-src/desktop/desktop-to-uwp-manual-conversion.md ✅Succeeded

For more details, please refer to the build report.

- Replace the emdash with standard punctuation to match the file's style.
- Drop the '(Optional)' prefix from the heading; optionality is already
  conveyed in the section body.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 18e32334-aec6-40fd-a4f8-0631ef4d5840
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit cf8f266:

✅ Validation status: passed

File Status Preview URL Details
msix-src/desktop/desktop-to-uwp-manual-conversion.md ✅Succeeded

For more details, please refer to the build report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant