Skip to content

.sync: Enable the patina alloc feature in the doc tasks - #214

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

.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

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

Signed-off-by: Vineel Kovvuri[MSFT] <vineelko@microsoft.com>
@vineelko
vineelko enabled auto-merge (squash) October 26, 2026 19:34
vineelko added a commit to OpenDevicePartnership/patina that referenced this pull request Oct 26, 2026
## 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).

Signed-off-by: Vineel Kovvuri[MSFT] <vineelko@microsoft.com>
@vineelko
vineelko merged commit ed81f85 into OpenDevicePartnership:main Oct 26, 2026
3 checks passed
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.

3 participants