Commit 1f813ec3 authored by Chen Wang's avatar Chen Wang Committed by Jim Harris
Browse files

doc: fix typos in the doc directory 



Change-Id: Ifff553ed70ce5aa8e7bdf6d8a8e9e9afb73e8a64
Signed-off-by: default avatarChen Wang <chenx.wang@intel.com>
Reviewed-on: https://review.gerrithub.io/423497


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 9e132fbc

CHANGELOG.md

+2 −2
Original line number Diff line number Diff line
@@ -265,7 +265,7 @@ A new `destroy_lvol_bdev` RPC method to delete logical volumes has been added. 


Lvols now have their own UUIDs which replace previous LvolStoreUUID_BlobID combination.



New Snapshot and Clone funtionalities have been added. User may create Snapshots of existing Lvols

New Snapshot and Clone functionalities have been added. User may create Snapshots of existing Lvols

and Clones of existing Snapshots.

See the [lvol snapshots](http://www.spdk.io/doc/logical_volumes.html#lvol_snapshots) documentation

for more details.
@@ -414,7 +414,7 @@ See the [GPT](http://www.spdk.io/doc/bdev.html#bdev_config_gpt) documentation fo 


### FIO plugin



SPDK `fio_plugin` now suports FIO 3.3. The support for previous FIO 2.21 has been dropped,

SPDK `fio_plugin` now supports FIO 3.3. The support for previous FIO 2.21 has been dropped,

although it still remains to work for now. The new FIO contains huge amount of bugfixes and

it's recommended to do an update.

README.md

+2 −2
Original line number Diff line number Diff line
@@ -124,7 +124,7 @@ For example: 
./configure --with-rdma

~~~



Additionally, `CONFIG` options may also be overrriden on the `make` command

Additionally, `CONFIG` options may also be overridden on the `make` command

line:



~~~{.sh}
@@ -188,5 +188,5 @@ vfio. 
## Contributing



For additional details on how to get more involved in the community, including

[contributing code](http://www.spdk.io/development) and participating in discussions and other activiites, please

[contributing code](http://www.spdk.io/development) and participating in discussions and other activities, please

refer to [spdk.io](http://www.spdk.io/community)

doc/applications.md

+1 −1
Original line number Diff line number Diff line
@@ -77,7 +77,7 @@ For more details see @ref jsonrpc documentation. 
### Create just one hugetlbfs file {#cmd_arg_single_file_segments}



Instead of creating one hugetlbfs file per page, this option makes SPDK create

one file per hugepagesz per socket. This is needed for @ref virtio to be used

one file per hugepages per socket. This is needed for @ref virtio to be used

with more than 8 hugepages. See @ref virtio_2mb.



### Multi process mode {#cmd_arg_multi_process}

doc/bdev.md

+3 −3
Original line number Diff line number Diff line
@@ -101,7 +101,7 @@ possibly multiple virtual bdevs. 
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

standard partitioning tools. After partitioning, the bdevs will need to be deleted and

attached again fot the GPT bdev module to see any changes. NBD kernel module must be

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 `start_nbd_disk` RPC command.



Example command
@@ -224,7 +224,7 @@ please refer to @ref lvol. 


Before creating any logical volumes (lvols), an lvol store has to be created first on

selected block device. Lvol store is lvols vessel responsible for managing underlying

bdev space assigment to lvol bdevs and storing metadata. To create lvol store user

bdev space assignment to lvol bdevs and storing metadata. To create lvol store user

should use using `construct_lvol_store` RPC command.



Example command
@@ -274,7 +274,7 @@ Example commands 
# Passthru {#bdev_config_passthru}



The SPDK Passthru virtual block device module serves as an example of how to write a

virutal block device module. It implements the required functionality of a vbdev module

virtual block device module. It implements the required functionality of a vbdev module

and demonstrates some other basic features such as the use of per I/O context.



Example commands

doc/blob.md

+1 −1
Original line number Diff line number Diff line
@@ -314,7 +314,7 @@ Cluster 0 is special and has the following format, where page 0 is the first pag 


The super block is a single page located at the beginning of the partition. It contains basic information about

the Blobstore. The metadata region is the remainder of cluster 0 and may extend to additional clusters. Refer

to the latest srouce code for complete structural details of the super block and metadata region.

to the latest source code for complete structural details of the super block and metadata region.



Each blob is allocated a non-contiguous set of pages inside the metadata region for its metadata. These pages

form a linked list. The first page in the list will be written in place on update, while all other pages will