Skip to content

Commit cd16a58

Browse files
committed
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>
1 parent 5b75ec0 commit cd16a58

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

docs/amd_sev_snp.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22

33
### WARNING
44

5-
This feature is only currently supported on MSHV.
5+
This feature is currently only supported on MSHV.
66

77
AMD Secure Encrypted Virtualization & Secure Nested Paging (SEV-SNP) is an AMD
88
technology designed to add strong memory integrity protection to help prevent
99
malicious hypervisor-based attacks like data replay, memory-remapping and more
1010
in order to create an isolated execution environment. Here are some useful
1111
links:
1212

13-
- [SNP Homepage](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/solution-briefs/amd-secure-encrypted-virtualization-solution-brief.pdf):
13+
- [SNP Homepage](https://docs.amd.com/v/u/en-US/amd-secure-encrypted-virtualization-solution-brief):
1414
more information about SEV-SNP technical aspects, design and specification.
1515

1616
## Cloud Hypervisor support
1717

18-
It is required to use a machine which has enabled support for AMD SEV-SNP in
19-
the BIOS.
18+
A machine with AMD SEV-SNP support which is enabled in the BIOS is required.
2019

2120
On the Cloud Hypervisor side, all you need is to build the project with the
2221
`sev_snp` feature enabled:
@@ -26,7 +25,7 @@ cargo build --no-default-features --features "sev_snp"
2625
```
2726

2827
**Note**
29-
Please note that `sev_snp` cannot be enabled in conjunction with `tdx` feature flag.
28+
Please note that `sev_snp` cannot be enabled in conjunction with the `tdx` feature flag.
3029

3130
You can run a SEV-SNP VM using the following command:
3231

@@ -38,4 +37,4 @@ You can run a SEV-SNP VM using the following command:
3837
--disk path=ubuntu.img
3938
```
4039

41-
For more information related to Microsoft Hypervisor please see [mshv.md](mshv.md)
40+
For more information related to Microsoft Hypervisor, please see [mshv.md](mshv.md)

docs/intel_tdx.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ meaning it will be printing guest kernel logs to the `virtio-console` device.
7575

7676
```bash
7777
./cloud-hypervisor \
78-
--platform tdx=on
78+
--platform tdx=on \
7979
--firmware edk2/Build/IntelTdx/RELEASE_GCC5/FV/OVMF.fd \
8080
--cpus boot=1 \
8181
--memory size=1G \
@@ -87,7 +87,7 @@ firmware:
8787

8888
```bash
8989
./cloud-hypervisor \
90-
--platform tdx=on
90+
--platform tdx=on \
9191
--firmware edk2/Build/IntelTdx/DEBUG_GCC5/FV/OVMF.fd \
9292
--cpus boot=1 \
9393
--memory size=1G \
@@ -105,7 +105,7 @@ This is a lightweight version of the TDVF, written in Rust and designed for
105105
direct kernel boot, which is useful for containers use cases.
106106

107107
To build TDShim from source, it is required to install `Rust`, `NASM`,
108-
and `LLVM` first. The TDshim can be build as follows:
108+
and `LLVM` first. The TDshim can be built as follows:
109109

110110
```bash
111111
git clone https://github.com/confidential-containers/td-shim
@@ -136,10 +136,10 @@ option as well.
136136

137137
```bash
138138
./cloud-hypervisor \
139-
--platform tdx=on
139+
--platform tdx=on \
140140
--firmware td-shim/target/release/final.bin \
141141
--kernel bzImage \
142-
--cmdline "root=/dev/vda3 console=hvc0 rw"
142+
--cmdline "root=/dev/vda3 console=hvc0 rw" \
143143
--cpus boot=1 \
144144
--memory size=1G \
145145
--disk path=tdx_guest_img
@@ -150,10 +150,10 @@ TDShim:
150150

151151
```bash
152152
./cloud-hypervisor \
153-
--platform tdx=on
153+
--platform tdx=on \
154154
--firmware td-shim/target/debug/final.bin \
155155
--kernel bzImage \
156-
--cmdline "root=/dev/vda3 console=hvc0 rw"
156+
--cmdline "root=/dev/vda3 console=hvc0 rw" \
157157
--cpus boot=1 \
158158
--memory size=1G \
159159
--disk path=tdx_guest_img

0 commit comments

Comments
 (0)