docs: document openhcl_boot's memory layout and how it lays out memory for openhcl
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 238
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 100
Description
Do we have docs/diagrams showing the whole memory layout?
Originally posted by @smalis-msft in https://github.com/microsoft/openvmm/pull/3312#discussion_r3156875262
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the openhcl_boot entry point and any existing docs or diagrams about how it lays out memory for OpenHCL. Document the complete memory layout and how openhcl_boot constructs it, with a diagram if appropriate; the work is done when the layout is understandable from the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100