Commit 12fcbc9b authored by wawryk's avatar wawryk Committed by Tomasz Zawadzki
Browse files

markdownlint: enable rule MD013 - line_length 



Fixed all MD013 errors

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


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>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent e4d23dc7

CHANGELOG.md

+4 −2
Original line number Diff line number Diff line
@@ -3055,7 +3055,8 @@ See the [Pmem Block Device](http://www.spdk.io/doc/bdev.html#bdev_config_pmem) d 
A userspace driver for Virtio SCSI devices has been added.

The driver is capable of creating block devices on top of LUNs exposed by another SPDK vhost-scsi application.



See the [Virtio SCSI](http://www.spdk.io/doc/virtio.html) documentation and [Getting Started](http://www.spdk.io/doc/bdev.html#bdev_config_virtio_scsi) guide for more information.

See the [Virtio SCSI](http://www.spdk.io/doc/virtio.html) documentation and

[Getting Started](http://www.spdk.io/doc/bdev.html#bdev_config_virtio_scsi) guide for more information.



### Vhost target
@@ -3362,7 +3363,8 @@ user code. 


## v1.2.0: IOAT user-space driver



This release adds a user-space driver with support for the Intel I/O Acceleration Technology (I/OAT, also known as "Crystal Beach") DMA offload engine.

This release adds a user-space driver with support for the Intel I/O Acceleration Technology

(I/OAT, also known as "Crystal Beach") DMA offload engine.



- IOAT

  - New user-space driver supporting DMA memory copy offload

doc/accel_fw.md

+9 −3
Original line number Diff line number Diff line
@@ -10,7 +10,10 @@ acceleration capabilities. ISA/L is used for optimized CRC32C calculation within 
the software module.



The framework includes an API for getting the current capabilities of the

selected module. See [`spdk_accel_get_capabilities`](https://spdk.io/doc/accel__engine_8h.html) for more details. For the software module, all capabilities will be reported as supported. For the hardware modules, only functions accelerated by hardware will be reported however any function can still be called, it will just be backed by software if it is not reported as a supported capability.

selected module. See [`spdk_accel_get_capabilities`](https://spdk.io/doc/accel__engine_8h.html) for more details.

For the software module, all capabilities will be reported as supported. For the hardware modules, only functions

accelerated by hardware will be reported however any function can still be called, it will just be backed by

software if it is not reported as a supported capability.



# Acceleration Framework Functions {#accel_functions}
@@ -63,8 +66,11 @@ To use the IOAT engine, use the RPC [`ioat_scan_accel_engine`](https://spdk.io/d 


## IDXD Module {#accel_idxd}



To use the DSA engine, use the RPC [`idxd_scan_accel_engine`](https://spdk.io/doc/jsonrpc.html) with an optional parameter of `-c` and provide a configuration number of either 0 or 1. These pre-defined configurations determine how the DSA engine will be setup in terms

of work queues and engines.  The DSA engine is very flexible allowing for various configurations of these elements to either account for different quality of service requirements or to isolate hardware paths where the back end media is of varying latency (i.e. persistent memory vs DRAM).  The pre-defined configurations are as follows:

To use the DSA engine, use the RPC [`idxd_scan_accel_engine`](https://spdk.io/doc/jsonrpc.html) with an optional parameter

of `-c` and provide a configuration number of either 0 or 1. These pre-defined configurations determine how the DSA engine

will be setup in terms of work queues and engines.  The DSA engine is very flexible allowing for various configurations of

these elements to either account for different quality of service requirements or to isolate hardware paths where the back

end media is of varying latency (i.e. persistent memory vs DRAM).  The pre-defined configurations are as follows:



0: A single work queue backed with four DSA engines.  This is a generic configuration

that enables the hardware to best determine which engine to use as it pulls in new

doc/bdev.md

+2 −1
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ 


# Target Audience {#bdev_ug_targetaudience}



This user guide is intended for software developers who have knowledge of block storage, storage drivers, issuing JSON-RPC commands and storage services such as RAID, compression, crypto, and others.

This user guide is intended for software developers who have knowledge of block storage, storage drivers, issuing JSON-RPC

commands and storage services such as RAID, compression, crypto, and others.



# Introduction {#bdev_ug_introduction}

doc/containers.md

+2 −1
Original line number Diff line number Diff line
@@ -78,7 +78,8 @@ Your output should look something like this: 
~~~{.sh}

$ sudo docker run --privileged -v //dev//hugepages://dev//hugepages hello:1.0

Starting SPDK v20.01-pre git sha1 80da95481 // DPDK 19.11.0 initialization...

[ DPDK EAL parameters: hello_world -c 0x1 --log-level=lib.eal:6 --log-level=lib.cryptodev:5 --log-level=user1:6 --iova-mode=pa --base-virtaddr=0x200000000000 --match-allocations --file-prefix=spdk0 --proc-type=auto ]

[ DPDK EAL parameters: hello_world -c 0x1 --log-level=lib.eal:6 --log-level=lib.cryptodev:5 --log-level=user1:6 --iova-mode=pa

--base-virtaddr=0x200000000000 --match-allocations --file-prefix=spdk0 --proc-type=auto ]

EAL: No available hugepages reported in hugepages-1048576kB

Initializing NVMe Controllers

Attaching to 0000:06:00.0

doc/jsonrpc.md

+20 −9
Original line number Diff line number Diff line
@@ -2756,7 +2756,8 @@ Example response: 


## bdev_nvme_set_options {#rpc_bdev_nvme_set_options}



Set global parameters for all bdev NVMe. This RPC may only be called before SPDK subsystems have been initialized or any bdev NVMe has been created.

Set global parameters for all bdev NVMe. This RPC may only be called before SPDK subsystems have been initialized

or any bdev NVMe has been created.



### Parameters
@@ -4720,7 +4721,9 @@ data_out_pool_size | Optional | number | Number of data out buffer 


To load CHAP shared secret file, its path is required to specify explicitly in the parameter `auth_file`.



Parameters `disable_chap` and `require_chap` are mutually exclusive. Parameters `no_discovery_auth`, `req_discovery_auth`, `req_discovery_auth_mutual`, and `discovery_auth_group` are still available instead of `disable_chap`, `require_chap`, `mutual_chap`, and `chap_group`, respectivey but will be removed in future releases.

Parameters `disable_chap` and `require_chap` are mutually exclusive. Parameters `no_discovery_auth`, `req_discovery_auth`,

`req_discovery_auth_mutual`, and `discovery_auth_group` are still available instead of `disable_chap`, `require_chap`,

`mutual_chap`, and `chap_group`, respectivey but will be removed in future releases.



### Example
@@ -6870,7 +6873,8 @@ tgt_name | Optional | string | Parent NVMe-oF target nam 
### Response



The response is an object containing NVMf subsystem statistics.

In the response, `admin_qpairs` and `io_qpairs` are reflecting cumulative queue pair counts while `current_admin_qpairs` and `current_io_qpairs` are showing the current number.

In the response, `admin_qpairs` and `io_qpairs` are reflecting cumulative queue pair counts while

`current_admin_qpairs` and `current_io_qpairs` are showing the current number.



### Example
@@ -7820,7 +7824,8 @@ Example response: 


## bdev_lvol_inflate {#rpc_bdev_lvol_inflate}



Inflate a logical volume. All unallocated clusters are allocated and copied from the parent or zero filled if not allocated in the parent. Then all dependencies on the parent are removed.

Inflate a logical volume. All unallocated clusters are allocated and copied from the parent or zero filled

if not allocated in the parent. Then all dependencies on the parent are removed.



### Parameters
@@ -7855,7 +7860,9 @@ Example response: 


## bdev_lvol_decouple_parent {#rpc_bdev_lvol_decouple_parent}



Decouple the parent of a logical volume. For unallocated clusters which is allocated in the parent, they are allocated and copied from the parent, but for unallocated clusters which is thin provisioned in the parent, they are kept thin provisioned. Then all dependencies on the parent are removed.

Decouple the parent of a logical volume. For unallocated clusters which is allocated in the parent, they are

allocated and copied from the parent, but for unallocated clusters which is thin provisioned in the parent,

they are kept thin provisioned. Then all dependencies on the parent are removed.



### Parameters
@@ -8506,7 +8513,8 @@ Example response: 


Request notifications. Returns array of notifications that happend since the specified id (or first that is available).



Notice: Notifications are kept in circular buffer with limited size. Older notifications might be inaccesible due to being overwritten by new ones.

Notice: Notifications are kept in circular buffer with limited size. Older notifications might be inaccesible

due to being overwritten by new ones.



### Parameters
@@ -8565,7 +8573,8 @@ Example response: 


# Linux Network Block Device (NBD) {#jsonrpc_components_nbd}



SPDK supports exporting bdevs through Linux nbd. These devices then appear as standard Linux kernel block devices and can be accessed using standard utilities like fdisk.

SPDK supports exporting bdevs through Linux nbd. These devices then appear as standard Linux kernel block devices

and can be accessed using standard utilities like fdisk.



In order to export a device over nbd, first make sure the Linux kernel nbd driver is loaded by running 'modprobe nbd'.
@@ -8809,7 +8818,8 @@ Example response: 


Set cache pool size for blobfs filesystems.  This RPC is only permitted when the cache pool is not already initialized.



The cache pool is initialized when the first blobfs filesystem is initialized or loaded.  It is freed when the all initialized or loaded filesystems are unloaded.

The cache pool is initialized when the first blobfs filesystem is initialized or loaded.  It is freed when the all

initialized or loaded filesystems are unloaded.



### Parameters
@@ -8993,7 +9003,8 @@ Example response: 


Send NVMe command directly to NVMe controller or namespace. Parameters and responses encoded by base64 urlsafe need further processing.



Notice: bdev_nvme_send_cmd requires user to guarentee the correctness of NVMe command itself, and also optional parameters. Illegal command contents or mismatching buffer size may result in unpredictable behavior.

Notice: bdev_nvme_send_cmd requires user to guarentee the correctness of NVMe command itself, and also optional parameters.

Illegal command contents or mismatching buffer size may result in unpredictable behavior.



### Parameters