From a41c031609bc4880302014491cb6e28b3cc145df Mon Sep 17 00:00:00 2001 From: Karol Latecki Date: Fri, 7 Feb 2020 12:36:49 +0100 Subject: [PATCH] Fix Markdown MD012 linter warnings - multiple blank lines MD012 - Multiple consecutive blank lines Signed-off-by: Karol Latecki Change-Id: I3f48cdc54b1587c9ef2185b88f608ba8420f738b Signed-off-by: Karol Latecki Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/654 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto --- CHANGELOG.md | 3 --- doc/applications.md | 1 - doc/blob.md | 1 - doc/ftl.md | 2 -- doc/jsonrpc.md | 5 ----- doc/nvme.md | 1 - doc/vhost.md | 1 - examples/nvme/fio_plugin/README.md | 1 - examples/nvmf/nvmf/README.md | 2 ++ test/common/config/README.md | 1 - 10 files changed, 2 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d028fb92..d9ea2b4fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1908,7 +1908,6 @@ See the [Virtio SCSI](http://www.spdk.io/doc/virtio.html) documentation and [Get The vhost target application now supports live migration between QEMU instances. - ## v17.07: Build system improvements, userspace vhost-blk target, and GPT bdev ### Build System @@ -1985,7 +1984,6 @@ This analysis provides: See the VTune Amplifier documentation for more information. - ## v17.03: Blobstore and userspace vhost-scsi target ### Blobstore and BlobFS @@ -2225,7 +2223,6 @@ This release adds a user-space driver with support for the Intel I/O Acceleratio - Declarations and `nvme/identify` support for Intel SSD DC P3700 series vendor-specific log pages and features - Updated to support DPDK 2.2.0 - ## v1.0.0: NVMe user-space driver This is the initial open source release of the Storage Performance Development Kit (SPDK). diff --git a/doc/applications.md b/doc/applications.md index de7839c6d..f841b1c84 100644 --- a/doc/applications.md +++ b/doc/applications.md @@ -47,7 +47,6 @@ Param | Long Param | Type | Default | Descript | | --huge-dir | string | the first discovered | allocate hugepages from a specific mount -L | --logflag | string | | @ref cmd_arg_debug_log_flags - ### Configuration file {#cmd_arg_config_file} Historically, the SPDK applications were configured using a configuration file. diff --git a/doc/blob.md b/doc/blob.md index 6e10562d4..832d0d0bf 100644 --- a/doc/blob.md +++ b/doc/blob.md @@ -87,7 +87,6 @@ The Blobstore defines a hierarchy of storage abstractions as follows. 35, { alignment: 'center', fill: 'white' }); - for (var j = 0; j < 4; j++) { let pageWidth = 100; let pageHeight = canvasHeight; diff --git a/doc/ftl.md b/doc/ftl.md index 5807d62db..1168393dd 100644 --- a/doc/ftl.md +++ b/doc/ftl.md @@ -51,14 +51,12 @@ metadata is split in two parts: sequence number, etc.), located at the beginning blocks of the band, * the tail part, containing the address map and the valid map, located at the end of the band. - head metadata band's data tail metadata +-------------------+-------------------------------+------------------------+ |zone 1 |...|zone n |...|...|zone 1 |...| | ... |zone m-1 |zone m| |block 1| |block 1| | |block x| | | |block y |block y| +-------------------+-------------+-----------------+------------------------+ - Bands are written sequentially (in a way that was described earlier). Before a band can be written to, all of its zones need to be erased. During that time, the band is considered to be in a `PREP` state. After that is done, the band transitions to the `OPENING` state, in which head metadata diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 7aff53c50..01db2db55 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -2227,7 +2227,6 @@ Example response: } ~~~ - ## bdev_pmem_create_pool {#rpc_bdev_pmem_create_pool} Create a @ref bdev_config_pmem blk pool file. It is equivalent of following `pmempool create` command: @@ -4642,7 +4641,6 @@ ctrlr | Required | string | Controller name io_queues | Required | number | Number between 1 and 31 of IO queues for the controller cpumask | Optional | string | @ref cpu_mask for this controller - ### Example Example request: @@ -4724,7 +4722,6 @@ bdev_name | Required | string | Name of bdev to expose block readonly | Optional | boolean | If true, this target will be read only (default: false) cpumask | Optional | string | @ref cpu_mask for this controller - ### Example Example request: @@ -4764,7 +4761,6 @@ Name | Optional | Type | Description ----------------------- | -------- | ----------- | ----------- name | Optional | string | Vhost controller name - ### Response {#rpc_vhost_get_controllers_response} Response is an array of objects describing requested controller(s). Common fields are: @@ -5526,7 +5522,6 @@ strip_size_kb | Required | number | Strip size in KB raid_level | Required | number | RAID level base_bdevs | Required | string | Base bdevs name, whitespace separated list in quotes - ### Example Example request: diff --git a/doc/nvme.md b/doc/nvme.md index 6f1fb8546..c21468a5c 100644 --- a/doc/nvme.md +++ b/doc/nvme.md @@ -280,7 +280,6 @@ Example: identical shm_id and non-overlapping core masks @sa spdk_nvme_probe, spdk_nvme_ctrlr_process_admin_completions - # NVMe Hotplug {#nvme_hotplug} At the NVMe driver level, we provide the following support for Hotplug: diff --git a/doc/vhost.md b/doc/vhost.md index c9c020436..d0e4f896c 100644 --- a/doc/vhost.md +++ b/doc/vhost.md @@ -337,7 +337,6 @@ vhost.c:1006:session_shutdown: *NOTICE*: Exiting We can see that `sdb` and `sdc` are SPDK vhost-scsi LUNs, and `vda` is SPDK a vhost-blk disk. - # Advanced Topics {#vhost_advanced_topics} ## Multi-Queue Block Layer (blk-mq) {#vhost_multiqueue} diff --git a/examples/nvme/fio_plugin/README.md b/examples/nvme/fio_plugin/README.md index 70c28ddd3..ec149220c 100644 --- a/examples/nvme/fio_plugin/README.md +++ b/examples/nvme/fio_plugin/README.md @@ -55,7 +55,6 @@ And remote devices accessed via NVMe over Fabrics will look like this: filename=trtype=RDMA adrfam=IPv4 traddr=192.168.100.8 trsvcid=4420 ns=1 - **Note**: The specification of the PCIe address should not use the normal ':' and instead only use '.'. This is a limitation in fio - it splits filenames on ':'. Also, the NVMe namespaces start at 1, not 0, and the namespace must be diff --git a/examples/nvmf/nvmf/README.md b/examples/nvmf/nvmf/README.md index e5ee7b6e3..c08db996f 100644 --- a/examples/nvmf/nvmf/README.md +++ b/examples/nvmf/nvmf/README.md @@ -1,10 +1,12 @@ # NVMe-oF target without SPDK event framework ## Overview + This example is used to show how to use the nvmf lib. In this example we want to encourage user to use RPC cmd so we would only support RPC style. ## Usage: + This example's usage is very similar with nvmf_tgt, difference is that you must use the RPC cmd to setup the nvmf target. diff --git a/test/common/config/README.md b/test/common/config/README.md index e4a15cf37..7ad37c143 100644 --- a/test/common/config/README.md +++ b/test/common/config/README.md @@ -8,7 +8,6 @@ for spinning up a VM capable of running the SPDK test suite. There is no need for external hardware to run these tests. The linux kernel comes with the drivers necessary to emulate an RDMA enabled NIC. NVMe controllers can also be virtualized in emulators such as QEMU. - ## VM Envronment Requirements (Host): - 8 GiB of RAM (for DPDK)