Refine osdk doc

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

View File

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

View File

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

View File

@ -60,7 +60,7 @@ Arguments for running QEMU
## Examples ## Examples
- Build a project with `./initramfs.cpio.gz` - 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 ```bash
cargo osdk build --initramfs="./initramfs.cpio.gz" --boot.protocol="multiboot2" cargo osdk build --initramfs="./initramfs.cpio.gz" --boot.protocol="multiboot2"

View File

@ -17,7 +17,7 @@ and one of the crate
(in the same directory as the crate's `Cargo.toml`). (in the same directory as the crate's `Cargo.toml`).
So which manifest should be used? So which manifest should be used?
The rules are The rules are:
- If running commands in the workspace root directory, - If running commands in the workspace root directory,
the `OSDK.toml` of the workspace will be used the `OSDK.toml` of the workspace will be used