Commit 1df1583b authored by wawryk's avatar wawryk Committed by Tomasz Zawadzki
Browse files

markdownlint: enable rule MD005 



MD005 - Inconsistent indentation for list items at the same level
Fixed all MD005 errors

Signed-off-by: default avatarwawryk <maciejx.wawryk@intel.com>
Change-Id: If6a12d6dab938094394a72c804f2a028f1c40f45
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8995


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent e5b5eabe

doc/iscsi.md

+27 −25
Original line number Diff line number Diff line
@@ -274,6 +274,7 @@ sde 
At the iSCSI level, we provide the following support for Hotplug:



1. bdev/nvme:



At the bdev/nvme level, we start one hotplug monitor which will call

spdk_nvme_probe() periodically to get the hotplug events. We provide the

private attach_cb and remove_cb for spdk_nvme_probe(). For the attach_cb,
@@ -283,6 +284,7 @@ At the iSCSI level, we provide the following support for Hotplug: 
handle the hot-remove event.



2. scsi/lun:



When the LUN receive the hot-remove notification from block device layer,

the LUN will be marked as removed, and all the IOs after this point will

return with check condition status. Then the LUN starts one poller which will

doc/nvme.md

+10 −10
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ 


# In this document {#nvme_toc}



* @ref nvme_intro

* @ref nvme_examples

* @ref nvme_interface

* @ref nvme_design

* @ref nvme_fabrics_host

* @ref nvme_multi_process

* @ref nvme_hotplug

* @ref nvme_cuse

- @ref nvme_intro

- @ref nvme_examples

- @ref nvme_interface

- @ref nvme_design

- @ref nvme_fabrics_host

- @ref nvme_multi_process

- @ref nvme_hotplug

- @ref nvme_cuse



# Introduction {#nvme_intro}

doc/vhost_processing.md

+12 −12
Original line number Diff line number Diff line
@@ -90,13 +90,13 @@ physically-discontiguous regions and Vhost-user specification puts a limit on 
their number - currently 8. The driver sends a single message for each region with

the following data:



 * file descriptor - for mmap

 * user address - for memory translations in Vhost-user messages (e.g.

- file descriptor - for mmap

- user address - for memory translations in Vhost-user messages (e.g.

  translating vring addresses)

 * guest address - for buffers addresses translations in vrings (for QEMU this

- guest address - for buffers addresses translations in vrings (for QEMU this

  is a physical address inside the guest)

 * user offset - positive offset for the mmap

 * size

- user offset - positive offset for the mmap

- size



The Master will send new memory regions after each memory change - usually

hotplug/hotremove. The previous mappings will be removed.
@@ -108,11 +108,11 @@ as they use common SCSI I/O to inquiry the underlying disk(s). 
Afterwards, the driver requests the number of maximum supported queues and

starts sending virtqueue data, which consists of:



 * unique virtqueue id

 * index of the last processed vring descriptor

 * vring addresses (from user address space)

 * call descriptor (for interrupting the driver after I/O completions)

 * kick descriptor (to listen for I/O requests - unused by SPDK)

- unique virtqueue id

- index of the last processed vring descriptor

- vring addresses (from user address space)

- call descriptor (for interrupting the driver after I/O completions)

- kick descriptor (to listen for I/O requests - unused by SPDK)



If multiqueue feature has been negotiated, the driver has to send a specific

*ENABLE* message for each extra queue it wants to be polled. Other queues are

mdl_rules.rb

+0 −1
Original line number Diff line number Diff line 
all

exclude_rule 'MD003'

exclude_rule 'MD004'

exclude_rule 'MD005'

exclude_rule 'MD006'

exclude_rule 'MD007'

exclude_rule 'MD009'

test/common/config/README.md

+26 −26

File changed.

Contains only whitespace changes.

CHANGELOG.md

+58 −58

File changed.

Contains only whitespace changes.

doc/overview.md

+7 −7

File changed.

Contains only whitespace changes.