Documentation fixes - #7602
Merged
Merged
Documentation fixes#7602
Conversation
Contributor
|
Do we really need these many commits? I was wondering if merge as all of those in same group as |
Contributor
Author
Thanks for the feedback! I've squashed the commits from 19 down to 5, grouped by topics: devices - balloon, cpu, memory, vdpa, virtiofs, etc. I kept them separate rather than a single commit because each group touches different functional areas, it's easier to revert and keep clearer git history for future reference. |
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 <[email protected]>
Fix some minor syntax issues in api/building document to make the sentences more fluent and easy to read. Signed-off-by: Yi Wang <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
phip1611
approved these changes
Jan 14, 2026
phip1611
left a comment
Member
There was a problem hiding this comment.
LGTM, nice contribution, thanks!
Merged
via the queue into
cloud-hypervisor:main
with commit Jan 14, 2026
03252f5
40 of 43 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.