Samuka007/asterinas
1
0
Fork 0
mirror of https://github.com/asterinas/asterinas.git synced 2025-06-22 17:03:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refine osdk doc

Browse Source
This commit is contained in:
Hsy-Intel
2024-03-11 15:21:23 +08:00
committed by Tate, Hongliang Tian
parent f7a9ed8739
commit 286a3514b3
4 changed files with 51 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/osdk/guide/create-project.md
View File

@ -39,11 +39,11 @@ contains the following contents:
```text
myos/
src/
lib.rs
Cargo.toml
OSDK.toml
rust-toolchain.toml
├── Cargo.toml
├── OSDK.toml
├── rust-toolchain.toml
└── src/
└── lib.rs
```
### `src/lib.rs`

22
docs/src/osdk/guide/work-in-workspace.md
View File

@ -36,17 +36,17 @@ The generated directory structure will be as follows:
```text
myworkspace/
Cargo.toml
OSDK.toml
rust-toolchain.toml
myos/
src/
lib.rs
Cargo.toml
mymodule/
src/
lib.rs
Cargo.toml
├── Cargo.toml
├── OSDK.toml
├── rust-toolchain.toml
├── myos/
│ ├── Cargo.toml
│ └── src/
│ └── lib.rs
└── mymodule/
├── Cargo.toml
└── src/
└── lib.rs
```
In addition to the two projects,

2
docs/src/osdk/reference/commands/build.md
View File

@ -60,7 +60,7 @@ Arguments for running QEMU
## Examples
- Build a project with `./initramfs.cpio.gz`
as the initramfs and `multiboot2` as the boot portocol:
as the initramfs and `multiboot2` as the boot protocol:
```bash
cargo osdk build --initramfs="./initramfs.cpio.gz" --boot.protocol="multiboot2"

68
docs/src/osdk/reference/manifest.md
View File

@ -17,7 +17,7 @@ and one of the crate
(in the same directory as the crate's `Cargo.toml`).
So which manifest should be used?
The rules are
The rules are:
- If running commands in the workspace root directory,
the `OSDK.toml` of the workspace will be used
@ -54,72 +54,72 @@ args = [ # <10>
1. The arguments provided will be passed to the guest kernel.
Optional. The default value is empty.
Optional. The default value is empty.
Each argument should be in one of the following two forms:
`KEY=VALUE` or `KEY` if no value is required.
Each `KEY` can appear at most once.
Each argument should be in one of the following two forms:
`KEY=VALUE` or `KEY` if no value is required.
Each `KEY` can appear at most once.
2. The arguments provided will be passed to the init process,
usually, the init shell.
Optional. The default value is empty.
Optional. The default value is empty.
3. The path to the built initramfs.
Optional. The default value is empty.
Optional. The default value is empty.
4. The bootloader used to boot the kernel.
Optional. The default value is `grub`.
Optional. The default value is `grub`.
The allowed values are `grub` and `qemu`
(`qemu` indicates that QEMU directly boots the kernel).
The allowed values are `grub` and `qemu`
(`qemu` indicates that QEMU directly boots the kernel).
5. The boot protocol used to boot the kernel.
Optional. The default value is `multiboot2`.
Optional. The default value is `multiboot2`.
The allowed values are `linux-efi-handover64`,
`linux-legacy32`, `multiboot`, and `multiboot2`.
The allowed values are `linux-efi-handover64`,
`linux-legacy32`, `multiboot`, and `multiboot2`.
6. The path of `grub-mkrescue`,
which is used to create a GRUB CD_ROM.
Optional. The default value is system path,
determined using `which grub-mkrescue`.
Optional. The default value is system path,
determined using `which grub-mkrescue`.
This argument only takes effect
when the bootloader is `grub`.
This argument only takes effect
when the bootloader is `grub`.
7. The path of OVMF. OVMF enables UEFI support for QEMU.
Optional. The default value is empty.
Optional. The default value is empty.
This argument only takes effect
when the boot protocol is `linux-efi-handover64`.
This argument only takes effect
when the boot protocol is `linux-efi-handover64`.
8. The path of QEMU.
Optional. The default value is system path,
determined using `which qemu-system-x86_64`.
Optional. The default value is system path,
determined using `which qemu-system-x86_64`.
9. The machine type of QEMU.
Optional. Default is `q35`.
Optional. Default is `q35`.
The allowed values are `q35` and `microvm`.
The allowed values are `q35` and `microvm`.
10. Additional arguments passed to QEMU.
Optional. The default value is empty.
Optional. The default value is empty.
Each argument should be in the form `KEY VALUE`
(separated by space),
or `KEY` if no value is required.
Some keys can appear multiple times
(e.g., `-device`, `-netdev`),
while other keys can appear at most once.
Certain keys, such as `-cpu` and `-machine`,
are not allowed to be set here
as they may conflict with the internal settings of OSDK.
Each argument should be in the form `KEY VALUE`
(separated by space),
or `KEY` if no value is required.
Some keys can appear multiple times
(e.g., `-device`, `-netdev`),
while other keys can appear at most once.
Certain keys, such as `-cpu` and `-machine`,
are not allowed to be set here
as they may conflict with the internal settings of OSDK.