Skip to content

Enable the alloc feature when building documentation - #1920

Merged
vineelko merged 1 commit into
OpenDevicePartnership:mainfrom
vineelko:users/vineelko/docs_alloc_fix_1026
Oct 26, 2026
Merged

vineelko merged 1 commit into
OpenDevicePartnership:mainfrom
vineelko:users/vineelko/docs_alloc_fix_1026

Conversation

@vineelko

@vineelko vineelko commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Description

Enable the alloc feature when building documentation

The patina, patina_debugger, patina_internal_core and
patina_internal_cpu crates now list alloc in their docs.rs metadata.
The doc and doc-open tasks in Makefile.toml now enable the alloc
feature of patina.

Fixes: #1919

Signed-off-by: Vineel Kovvuri[MSFT] vineelko@microsoft.com

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

How This Was Tested

Ran cargo make all and checked the generated documentation to ensure it includes the modules gated behind alloc.

Integration Instructions

The changes to Makefile.toml will be retrofitted to patina-devops afterward(OpenDevicePartnership/patina-devops#214).

@patina-automation

patina-automation Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

✅ QEMU Validation Passed

All QEMU validation jobs completed successfully.

Note: Q35 is only built on Windows hosts (QEMU boot is disabled due to a QEMU vfat issue).

Workflow run: https://github.com/OpenDevicePartnership/patina/actions/runs/40388164955

Boot Time to EFI Shell

Platform Elapsed
ArmVirt (Linux Host) 23.3s
Q35 (Linux Host) 34.4s

Dependencies

Repository Ref
patina a368d0d
patina-dxe-core-qemu 28cfae7
patina-fw-patcher 5e02eb7
patina-qemu firmware v4.1.3
patina-qemu build script 05d359d

This comment was automatically generated by the Patina QEMU PR Validation Post workflow.

@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

The patina, patina_debugger, patina_internal_core and
patina_internal_cpu crates now list alloc in their docs.rs metadata.
The doc and doc-open tasks in Makefile.toml now enable the alloc
feature of patina.

Fixes: OpenDevicePartnership#1919

Signed-off-by: Vineel Kovvuri[MSFT] <vineelko@microsoft.com>
@vineelko
vineelko force-pushed the users/vineelko/docs_alloc_fix_1026 branch from 71aa41a to a368d0d Compare October 26, 2026 19:25
@vineelko
vineelko requested a review from os-d October 26, 2026 19:25
@vineelko
vineelko enabled auto-merge (squash) October 26, 2026 19:34
@vineelko
vineelko merged commit 629f16d into OpenDevicePartnership:main Oct 26, 2026
11 checks passed
vineelko added a commit to OpenDevicePartnership/patina-devops that referenced this pull request Oct 26, 2026
.sync: Enable the patina alloc feature in the doc tasks

The doc and doc-open tasks in Makefile-patina.toml now pass the
alloc feature of patina to cargo doc.

The patina crate no longer enables alloc by default. Without the flag,
the generated docs omit every module that needs alloc.

Refs: OpenDevicePartnership/patina#1919,
OpenDevicePartnership/patina#1920

Signed-off-by: Vineel Kovvuri[MSFT] <vineelko@microsoft.com>

Signed-off-by: Vineel Kovvuri[MSFT] <vineelko@microsoft.com>
@vineelko
vineelko deleted the users/vineelko/docs_alloc_fix_1026 branch October 26, 2026 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact:non-functional Does not have a functional impact type:bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: alloc feature flag not enabled when building docs

3 participants