From 5cdab5e2e60dae4a65812c944f36d8556f139445 Mon Sep 17 00:00:00 2001 From: Dayu Liu Date: Mon, 11 May 2020 20:08:41 +0800 Subject: [PATCH] doc: fix some typos and align indent when setup.sh --help Signed-off-by: Dayu Liu Change-Id: Id0a2a3a577adfd5026b662d97d74c9ec6aebeb8e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2396 Community-CI: Mellanox Build Bot Reviewed-by: Changpeng Liu Reviewed-by: Ben Walker Tested-by: SPDK CI Jenkins --- doc/bdev.md | 2 +- doc/iscsi.md | 2 +- doc/vhost.md | 4 ++-- scripts/setup.sh | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 382901054..a98a313cd 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -261,7 +261,7 @@ possibly multiple virtual bdevs. ## SPDK GPT partition table {#bdev_ug_gpt} The SPDK partition type GUID is `7c5222bd-8f5d-4087-9c00-bf9843c7b58c`. Existing SPDK bdevs -can be exposed as Linux block devices via NBD and then ca be partitioned with +can be exposed as Linux block devices via NBD and then can be partitioned with standard partitioning tools. After partitioning, the bdevs will need to be deleted and attached again for the GPT bdev module to see any changes. NBD kernel module must be loaded first. To create NBD bdev user should use `nbd_start_disk` RPC command. diff --git a/doc/iscsi.md b/doc/iscsi.md index ec02c2855..08fb1319f 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -218,7 +218,7 @@ echo "1024" > /sys/block/sdc/queue/nr_requests ### Example: Configure simple iSCSI Target with one portal and two LUNs -Assuming we have one iSCSI Target server with portal at 10.0.0.1:3200, two LUNs (Malloc0 and Malloc), +Assuming we have one iSCSI Target server with portal at 10.0.0.1:3200, two LUNs (Malloc0 and Malloc1), and accepting initiators on 10.0.0.2/32, like on diagram below: ![Sample iSCSI configuration](iscsi_example.svg) diff --git a/doc/vhost.md b/doc/vhost.md index f03247dd7..96910509b 100644 --- a/doc/vhost.md +++ b/doc/vhost.md @@ -105,7 +105,7 @@ app/vhost/vhost -h ## Create bdev (block device) {#vhost_bdev_create} SPDK bdevs are block devices which will be exposed to the guest OS. -For vhost-scsi, bdevs are exposed as as SCSI LUNs on SCSI devices attached to the +For vhost-scsi, bdevs are exposed as SCSI LUNs on SCSI devices attached to the vhost-scsi controller in the guest OS. For vhost-blk, bdevs are exposed directly as block devices in the guest OS and are not associated at all with SCSI. @@ -373,7 +373,7 @@ be aborted - possibly flooding a VM with syslog warnings and errors. ### Hot-attach -Hot-attach is is done by simply attaching a bdev to a vhost controller with a QEMU VM +Hot-attach is done by simply attaching a bdev to a vhost controller with a QEMU VM already started. No other extra action is necessary. ~~~{.sh} diff --git a/scripts/setup.sh b/scripts/setup.sh index 37903d0e7..e5beabe7a 100755 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -32,7 +32,7 @@ function usage() { echo "$options - as following:" echo "config Default mode. Allocate hugepages and bind PCI devices." if [[ $os == Linux ]]; then - echo "cleanup Remove any orphaned files that can be left in the system after SPDK application exit" + echo "cleanup Remove any orphaned files that can be left in the system after SPDK application exit" fi echo "reset Rebind PCI devices back to their original drivers." echo " Also cleanup any leftover spdk files/resources."