Commit f2d4c777 authored by Jim Harris's avatar Jim Harris
Browse files

doc: fix up some bdev-related reference errors 



This includes removing use of lib/bdev/<module_name>
which confused Doxygen into thinking it was an xml/html tag.

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: Iebfe84c1cbc59cd7a62e88dafbe1725d7c2a49da

Reviewed-on: https://review.gerrithub.io/415851


Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
parent a27b0084

doc/bdev.md

+2 −2
Original line number Diff line number Diff line
@@ -136,10 +136,10 @@ This command will create a bdev that represents the 'foo' image from a pool call 
# GPT (GUID Partition Table) {#bdev_config_gpt}



The GPT virtual bdev driver is enabled by default and does not require any configuration.

It will automatically detect @ref bdev_ug_gpt_table on any attached bdev and will create

It will automatically detect @ref bdev_ug_gpt on any attached bdev and will create

possibly multiple virtual bdevs.



## SPDK GPT partition table {#bdev_ug_gpt_table}

## 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

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

doc/bdev_module.md

+1 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ how to write a module. 


## Creating A New Module



Block device modules are located in lib/bdev/<module_name> today. It is not

Block device modules are located in subdirectories under lib/bdev today. It is not

currently possible to place the code for a bdev module elsewhere, but updates

to the build system could be made to enable this in the future. To create a

module, add a new directory with a single C file and a Makefile. A great

doc/iscsi.md

+1 −1
Original line number Diff line number Diff line
@@ -52,7 +52,7 @@ ReactorMask 0xF000000 


## Configuring a LUN in the iSCSI Target {#iscsi_lun}



Each LUN in an iSCSI target node is associated with an SPDK block device.  See @ref bdev_getting_started

Each LUN in an iSCSI target node is associated with an SPDK block device.  See @ref bdev

for details on configuring SPDK block devices.  The block device to LUN mappings are specified in the

configuration file as:

doc/jsonrpc.md

+1 −1
Original line number Diff line number Diff line
@@ -80,7 +80,7 @@ Example response: 


# Block Device Abstraction Layer {#jsonrpc_components_bdev}



## set_bdev_options (#rpc_set_bdev_options}

## set_bdev_options {#rpc_set_bdev_options}



Set global parameters for the block device (bdev) subsystem.  This RPC may only be called

before subsystems have been initialized.

doc/vhost.md

+1 −1
Original line number Diff line number Diff line
@@ -103,7 +103,7 @@ For vhost-blk, bdevs are exposed directly as block devices in the guest OS and a 
not associated at all with SCSI.



SPDK supports several different types of storage backends, including NVMe,

Linux AIO, malloc ramdisk and Ceph RBD.  Refer to @ref bdev_getting_started for

Linux AIO, malloc ramdisk and Ceph RBD.  Refer to @ref bdev for

additional information on configuring SPDK storage backends.



This guide will use a malloc bdev (ramdisk) named Malloc0. The following RPC