Format OSDK documentation

This commit is contained in:
Jianfeng Jiang
2024-03-01 03:23:47 +00:00
committed by Tate, Hongliang Tian
parent 7fef686136
commit a51b3c7076
18 changed files with 397 additions and 162 deletions

View File

@ -1,6 +1,8 @@
# cargo osdk test
`cargo osdk test` is used to execute kernel mode unit test by starting QEMU. The usage is as follows:
`cargo osdk test` is used to
execute kernel mode unit test by starting QEMU.
The usage is as follows:
```bash
cargo osdk test [OPTIONS] [TESTNAME]
@ -8,14 +10,18 @@ cargo osdk test [OPTIONS] [TESTNAME]
## Arguments
[TESTNAME]: Only run tests containing this string in their names
[TESTNAME]:
Only run tests containing this string in their names
## Options
The options are the same as those of `cargo osdk build`. Refer to the [documentation](build.md) of `cargo osdk build` for more details.
The options are the same as those of `cargo osdk build`.
Refer to the [documentation](build.md) of `cargo osdk build`
for more details.
## Examples
- Execute tests containing foo in their names with q35 as the QEMU machine type:
- Execute tests containing foo in their names
with q35 as the QEMU machine type:
```bash
cargo osdk test foo --qemu.machine="q35"