Fix Markdown MD026 linter warnings - trailing punctuation in header
MD026 Trailing punctuation in header This rule is triggered on any header that has a punctuation character as the last character in the line Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I3ab4894092ef6b5f920d89b74e43c2e46e9581c0 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/657 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Karol Latecki
Tomasz Zawadzki
parent
93be26a51d
commit
71efe5db24
12
CHANGELOG.md
12
CHANGELOG.md
@ -199,7 +199,7 @@ code for fused compare-and-write operation.
|
||||
|
||||
Added spdk_bdev_get_acwu function for getting block device atomic compare and write unit size.
|
||||
|
||||
## v19.10:
|
||||
## v19.10
|
||||
|
||||
### rpc
|
||||
|
||||
@ -429,7 +429,7 @@ New cache modes added to use via RPC, wi - write invalidate and wa - write aroun
|
||||
|
||||
New version of OCF provides fully asynchronous management API.
|
||||
|
||||
## v19.07:
|
||||
## v19.07
|
||||
|
||||
### ftl
|
||||
|
||||
@ -705,7 +705,7 @@ with SPDK thread when necessary.
|
||||
Added spdk_thread_destroy() to allow framework polling the thread to
|
||||
release resources associated with that thread.
|
||||
|
||||
## v19.04:
|
||||
## v19.04
|
||||
|
||||
### nvme
|
||||
|
||||
@ -926,7 +926,7 @@ Added "reduce" block compression scheme based on using SSDs for storing
|
||||
compressed blocks of storage and presistent memory for metadata. Please see
|
||||
[compression](https://spdk.io/doc/bdev.html) for more details.
|
||||
|
||||
## v19.01:
|
||||
## v19.01
|
||||
|
||||
### ocf bdev
|
||||
|
||||
@ -1181,7 +1181,7 @@ JSON RPC client is now running in non-blocking mode. Requests are sent and recei
|
||||
JSON RPC server can now recieve a callback on connection termination or server shutdown using `spdk_jsonrpc_conn_add_close_cb`
|
||||
and `spdk_jsonrpc_conn_del_close_cb`.
|
||||
|
||||
## v18.10:
|
||||
## v18.10
|
||||
|
||||
### nvme
|
||||
|
||||
@ -1378,7 +1378,7 @@ in QEMU.
|
||||
The SPDKCLI interactive command tool for managing SPDK is no longer considered experimental.
|
||||
Support for the iSCSI and NVMe-oF targets has been added.
|
||||
|
||||
## v18.07:
|
||||
## v18.07
|
||||
|
||||
### bdev
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ The development kit currently includes:
|
||||
* [vhost target](http://www.spdk.io/doc/vhost.html)
|
||||
* [Virtio-SCSI driver](http://www.spdk.io/doc/virtio.html)
|
||||
|
||||
# In this readme:
|
||||
# In this readme
|
||||
|
||||
* [Documentation](#documentation)
|
||||
* [Prerequisites](#prerequisites)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# What is SPDK? {#about}
|
||||
# What is SPDK {#about}
|
||||
|
||||
The Storage Performance Development Kit (SPDK) provides a set of tools and
|
||||
libraries for writing high performance, scalable, user-mode storage
|
||||
|
||||
@ -35,7 +35,7 @@ NAND too.
|
||||
|
||||
## Theory of Operation {#blob_pg_theory}
|
||||
|
||||
### Abstractions:
|
||||
### Abstractions
|
||||
|
||||
The Blobstore defines a hierarchy of storage abstractions as follows.
|
||||
|
||||
|
||||
@ -196,7 +196,7 @@ Error occurred in Python command: No symbol table is loaded. Use the "file"
|
||||
command.
|
||||
~~~
|
||||
|
||||
# Macros available:
|
||||
# Macros available
|
||||
|
||||
- spdk_load_macros: load the macros (use --reload in order to reload them)
|
||||
- spdk_print_bdevs: information about bdevs
|
||||
@ -205,7 +205,7 @@ command.
|
||||
- spdk_print_nvmf_subsystems: information about nvmf subsystems
|
||||
- spdk_print_threads: information about threads
|
||||
|
||||
# Adding New Macros:
|
||||
# Adding New Macros
|
||||
|
||||
The list iteration macros are usually built from 3 layers:
|
||||
|
||||
|
||||
@ -3844,7 +3844,7 @@ c2h_success | Optional | boolean | Disable C2H success optimizat
|
||||
dif_insert_or_strip | Optional | boolean | Enable DIF insert for write I/O and DIF strip for read I/O DIF (TCP only)
|
||||
sock_priority | Optional | number | The socket priority of the connection owned by this transport (TCP only)
|
||||
|
||||
### Example:
|
||||
### Example
|
||||
|
||||
Example request:
|
||||
|
||||
|
||||
@ -135,7 +135,7 @@ Please contact your FC vendor for instructions to obtain FC driver module.
|
||||
FC LLD driver for Broadcom FC NVMe capable adapters can be obtained from,
|
||||
https://github.com/ecdufcdrvr/bcmufctdrvr.
|
||||
|
||||
### Fetch FC LLD module and then build SPDK with FC enabled:
|
||||
### Fetch FC LLD module and then build SPDK with FC enabled
|
||||
|
||||
After cloning SPDK repo and initialize submodules, FC LLD library is built which then can be linked with
|
||||
the fc transport.
|
||||
|
||||
@ -94,7 +94,7 @@ Plugins section (`plugins`):
|
||||
|
||||
- `plugin <plugin name> { [enable|disable] }` -- enable or disable VPP plugin.
|
||||
|
||||
### Example:
|
||||
### Example
|
||||
|
||||
~~~
|
||||
unix {
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
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:
|
||||
## 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.
|
||||
|
||||
@ -8,7 +8,7 @@ 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):
|
||||
## VM Envronment Requirements (Host)
|
||||
|
||||
- 8 GiB of RAM (for DPDK)
|
||||
- Enable intel_kvm on the host machine from the bios.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user