From f2d4c77797fa79741e8ed3a6d3de2dfc41f82f50 Mon Sep 17 00:00:00 2001 From: Jim Harris Date: Mon, 18 Jun 2018 07:14:31 -0700 Subject: [PATCH] doc: fix up some bdev-related reference errors This includes removing use of lib/bdev/ which confused Doxygen into thinking it was an xml/html tag. Signed-off-by: Jim Harris Change-Id: Iebfe84c1cbc59cd7a62e88dafbe1725d7c2a49da Reviewed-on: https://review.gerrithub.io/415851 Reviewed-by: Ben Walker Tested-by: SPDK Automated Test System --- doc/bdev.md | 4 ++-- doc/bdev_module.md | 2 +- doc/iscsi.md | 2 +- doc/jsonrpc.md | 2 +- doc/vhost.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 326a6a0b5..0ca754353 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -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 diff --git a/doc/bdev_module.md b/doc/bdev_module.md index a315b33b3..24a08df4b 100644 --- a/doc/bdev_module.md +++ b/doc/bdev_module.md @@ -18,7 +18,7 @@ how to write a module. ## Creating A New Module -Block device modules are located in lib/bdev/ 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 diff --git a/doc/iscsi.md b/doc/iscsi.md index 0ddfff5d3..6816eb62c 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -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: diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 98634b4a8..144a0983f 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -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. diff --git a/doc/vhost.md b/doc/vhost.md index 266f3ca47..3eba5e52f 100644 --- a/doc/vhost.md +++ b/doc/vhost.md @@ -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