From 6ee93dda1255e0debbf9e57d15cd1508de5e306c Mon Sep 17 00:00:00 2001 From: AlexChen Date: Sun, 27 Sep 2020 22:42:14 +0800 Subject: [PATCH] docs: Fixed some spelling and formatting issues Signed-off-by: AlexChen --- docs/config_guidebook.md | 10 +++++----- docs/mk_initrd.md | 2 +- docs/quickstart.md | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/config_guidebook.md b/docs/config_guidebook.md index 00641e8c0..13d628056 100644 --- a/docs/config_guidebook.md +++ b/docs/config_guidebook.md @@ -35,7 +35,7 @@ StratoVirt supports to set the size of VM's memory in cmdline. This allows you to set the size of memory that VM will support. You can choose `M` or `G` as unit (default unit is `Kib`). -But unfortunately, in json configuration file, only `byte` are supported as unit. +But unfortunately, in json configuration file, only `byte` is supported as unit. ```shell # cmdline @@ -115,8 +115,8 @@ Five properties are supported for virtio block device. * drive_id: unique device-id in StratoVirt * path_on_host: the path of block device in host -* serial_num: serial number of virtio block (Optional) -* read_only: whether virtio block device is read_only or not +* serial_num: serial number of virtio block (optional) +* read_only: whether virtio block device is read-only or not * direct: open block device with `O_DIRECT` mode or not If you want to boot VM with a virtio block device as rootfs, you should add `root=DEVICE_NAME_IN_GUESTOS` @@ -150,7 +150,7 @@ Three properties are supported for virtio net device. * iface_id: unique device-id in StratoVirt * host_dev_name: name of tap device in host -* mac: set mac address in VM (Optional) +* mac: set mac address in VM (optional) ```shell # cmdline @@ -310,7 +310,7 @@ There is only one argument for serial device: ## 3. StratoVirt Management -StratoVirt controls VM's lifetime and external api interface with [QMP](https://wiki.qemu.org/Documentation/QMP) +StratoVirt controls VM's lifecycle and external api interface with [QMP](https://wiki.qemu.org/Documentation/QMP) in current version. ### 3.1 Api-channel Creation diff --git a/docs/mk_initrd.md b/docs/mk_initrd.md index cd3036929..9d3558f39 100644 --- a/docs/mk_initrd.md +++ b/docs/mk_initrd.md @@ -46,7 +46,7 @@ EOF chmod +x etc/init.d/rcS ``` -## 5. make initrd image +## 5. Make initrd image ```shell cd _install diff --git a/docs/quickstart.md b/docs/quickstart.md index 142c9ab71..376cb2ccc 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -62,7 +62,7 @@ $ cargo build --release --target ${arch}-unknown-linux-gnu Now you can find StratoVirt binary file in `target/${arch}-unknown-linux-gnu/release/stratovirt`. -## 3. Prepare Kernel and rootfs Image +## 3. Prepare kernel and rootfs image ### 3.1 Build kernel @@ -153,13 +153,13 @@ Rootfs image is a file system image. An EXT4-format image with `/sbin/init` can ## 4. Run StratoVirt -With kernel and rootfs image, we can boot a guest Linux machine by StratoVirt. +With kernel and rootfs image, we can boot a guest linux machine by StratoVirt. ### 4.1 Run with cmdline The minimum configuration for StratoVirt is: -* A PE format Linux kernel +* A PE format linux kernel * A rootfs image as virtio-blk device, which has to be added to kernel parameters * Api-channel to control StratoVirt * If you want to login with ttyS0, you may need a serial and add ttyS0 to kernel parameters -- Gitee