Documentation fixes by up2wing · Pull Request #7602 · cloud-hypervisor/cloud-hypervisor · GitHub
Skip to content

Documentation fixes#7602

Merged
rbradford merged 5 commits intocloud-hypervisor:mainfrom
up2wing:doc-fix
Jan 14, 2026
Merged

Documentation fixes#7602
rbradford merged 5 commits intocloud-hypervisor:mainfrom
up2wing:doc-fix

Conversation

@up2wing
Copy link
Copy Markdown
Contributor

@up2wing up2wing commented Jan 13, 2026

When reading the cpu markdown, I found the CpusConfig in the doc was inconsistent with the source code, so I spend some time to review most of the files in docs and found some similar issues.
Most of the bash/command issues have been fixed, along with some minor syntax problems. I did my best, but I can't guarantee that every file is completely covered.
Well, this might seem insignificant, but it could make our project better, even if only slightly.

@up2wing up2wing requested a review from a team as a code owner January 13, 2026 16:57
@russell-islam
Copy link
Copy Markdown
Contributor

@up2wing
Copy link
Copy Markdown
Contributor Author

up2wing commented Jan 14, 2026

Some description in the device document were inconsistent with the
source code. Also fix some syntax issues to make the sentences more
fluent.

Signed-off-by: Yi Wang <foxywang@tencent.com>
Fix some minor syntax issues in api/building document to make
the sentences more fluent and easy to read.

Signed-off-by: Yi Wang <foxywang@tencent.com>
There are some minor syntax and command issues in debug-port document.

As commit 5febdec (vmm: Enable `gdbstub` on AArch64) supported
aarch64, the docs should keep consistent.

Signed-off-by: Yi Wang <foxywang@tencent.com>
There are some syntax and format issues in tdx/sev documents.
Make some modification to make the description more natural.

And the link of SEV-SNP is invalid, fix it.

Signed-off-by: Yi Wang <foxywang@tencent.com>
Minor modifications were made to make the sentences sound more natural.
Also fixed some parameter usage issues in bash code block.

Signed-off-by: Yi Wang <foxywang@tencent.com>
Copy link
Copy Markdown
Member

@phip1611 phip1611 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, nice contribution, thanks!

Copy link
Copy Markdown
Member

@rbradford rbradford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@rbradford rbradford added this pull request to the merge queue Jan 14, 2026
@rbradford rbradford changed the title Doc fix Documentation fixes Jan 14, 2026
Merged via the queue into cloud-hypervisor:main with commit 03252f5 Jan 14, 2026
40 of 43 checks passed
@github-project-automation github-project-automation Bot moved this from 🆕 New to ✅ Done in Cloud Hypervisor Roadmap Feb 19, 2026
@likebreath likebreath added the bug-fix Bug fix to include in release notes label Feb 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug-fix Bug fix to include in release notes

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

5 participants