docs: fix some syntax and format issues in tdx/sev

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>
This commit is contained in:
Yi Wang
2026-01-07 10:01:45 +08:00
committed by Rob Bradford
parent 2c2dec50f9
commit 34b8aed662
2 changed files with 12 additions and 13 deletions

View File

@@ -2,7 +2,7 @@
### WARNING
This feature is only currently supported on MSHV.
This feature is currently only supported on MSHV.
AMD Secure Encrypted Virtualization & Secure Nested Paging (SEV-SNP) is an AMD
technology designed to add strong memory integrity protection to help prevent
@@ -10,13 +10,12 @@ malicious hypervisor-based attacks like data replay, memory-remapping and more
in order to create an isolated execution environment. Here are some useful
links:
- [SNP Homepage](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/solution-briefs/amd-secure-encrypted-virtualization-solution-brief.pdf):
- [SNP Homepage](https://docs.amd.com/v/u/en-US/amd-secure-encrypted-virtualization-solution-brief):
more information about SEV-SNP technical aspects, design and specification.
## Cloud Hypervisor support
It is required to use a machine which has enabled support for AMD SEV-SNP in
the BIOS.
A machine with AMD SEV-SNP support which is enabled in the BIOS is required.
On the Cloud Hypervisor side, all you need is to build the project with the
`sev_snp` feature enabled:
@@ -26,7 +25,7 @@ cargo build --no-default-features --features "sev_snp"
```
**Note**
Please note that `sev_snp` cannot be enabled in conjunction with `tdx` feature flag.
Please note that `sev_snp` cannot be enabled in conjunction with the `tdx` feature flag.
You can run a SEV-SNP VM using the following command:
@@ -38,4 +37,4 @@ You can run a SEV-SNP VM using the following command:
--disk path=ubuntu.img
```
For more information related to Microsoft Hypervisor please see [mshv.md](mshv.md)
For more information related to Microsoft Hypervisor, please see [mshv.md](mshv.md)

View File

@@ -75,7 +75,7 @@ meaning it will be printing guest kernel logs to the `virtio-console` device.
```bash
./cloud-hypervisor \
--platform tdx=on
--platform tdx=on \
--firmware edk2/Build/IntelTdx/RELEASE_GCC5/FV/OVMF.fd \
--cpus boot=1 \
--memory size=1G \
@@ -87,7 +87,7 @@ firmware:
```bash
./cloud-hypervisor \
--platform tdx=on
--platform tdx=on \
--firmware edk2/Build/IntelTdx/DEBUG_GCC5/FV/OVMF.fd \
--cpus boot=1 \
--memory size=1G \
@@ -105,7 +105,7 @@ This is a lightweight version of the TDVF, written in Rust and designed for
direct kernel boot, which is useful for containers use cases.
To build TDShim from source, it is required to install `Rust`, `NASM`,
and `LLVM` first. The TDshim can be build as follows:
and `LLVM` first. The TDshim can be built as follows:
```bash
git clone https://github.com/confidential-containers/td-shim
@@ -136,10 +136,10 @@ option as well.
```bash
./cloud-hypervisor \
--platform tdx=on
--platform tdx=on \
--firmware td-shim/target/release/final.bin \
--kernel bzImage \
--cmdline "root=/dev/vda3 console=hvc0 rw"
--cmdline "root=/dev/vda3 console=hvc0 rw" \
--cpus boot=1 \
--memory size=1G \
--disk path=tdx_guest_img
@@ -150,10 +150,10 @@ TDShim:
```bash
./cloud-hypervisor \
--platform tdx=on
--platform tdx=on \
--firmware td-shim/target/debug/final.bin \
--kernel bzImage \
--cmdline "root=/dev/vda3 console=hvc0 rw"
--cmdline "root=/dev/vda3 console=hvc0 rw" \
--cpus boot=1 \
--memory size=1G \
--disk path=tdx_guest_img