Skip to content

Commit e9a3965

Browse files
committed
[doc] update crate doc comment to load from README.md
1 parent f204e83 commit e9a3965

File tree

2 files changed

+6
-18
lines changed

2 files changed

+6
-18
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Poster in RISC-V Days Tokyo 2024 Summer: [PDF](https://riscv.or.jp/wp-content/up
88
## Run Linux
99
### Build QEMU
1010
We need to build manually the QEMU to support IOMMU.
11-
```
11+
```sh
1212
$ git clone https://github.com/qemu/qemu.git -b staging
1313
$ cd qemu/
1414
# https://patchwork.ozlabs.org/project/qemu-devel/list/?series=417654
@@ -21,7 +21,7 @@ $ make -j $(nproc)
2121
Ver. 9.2 or later should officially support IOMMU, so it should no longer be necessary to apply patches.
2222

2323
### Build Linux
24-
```
24+
```sh
2525
$ git clone https://github.com/torvalds/linux -b v6.9
2626

2727
$ cd /path/to/this/repository
@@ -35,7 +35,7 @@ $ mv vmlinux /path/to/this/repository
3535
See also for custom guest image: `guest_image/README.md`.
3636

3737
### Create rootfs
38-
```
38+
```sh
3939
$ git clone https://gitee.com/mirrors/busyboxsource.git
4040
$ cd busyboxsource
4141

@@ -70,13 +70,13 @@ $ mv rootfs.img /path/to/this/repository
7070
```
7171

7272
### Run
73-
```
73+
```sh
7474
# The actual command to be executed is written in .cargo/config.toml.
7575
$ cargo r
7676
```
7777

7878
## Documents
79-
```
79+
```sh
8080
$ cargo doc --open
8181
```
8282

src/main.rs

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,4 @@
1-
//! hikami - Light weight type-1 hypervisor for RISC-V H-extension.
2-
//!
3-
//! ## Run
4-
//! ```no_run
5-
//! # The actual command to be executed is written in .cargo/config.toml.
6-
//! $ cargo r
7-
//! ```
8-
//!
9-
//! ## Documents
10-
//! ```no_run
11-
//! $ cargo doc --open
12-
//! ```
13-
1+
#![doc = include_str!("../README.md")]
142
#![no_main]
153
#![no_std]
164

0 commit comments

Comments
 (0)