From e96beb937419cce330ce79c8b91fa257bb29c48e Mon Sep 17 00:00:00 2001 From: wawryk Date: Fri, 30 Jul 2021 12:00:38 +0200 Subject: [PATCH] markdownlint: enable rule MD006 MD006 - Consider starting bulleted lists at the beginning of the line Fixed all errors Signed-off-by: wawryk Change-Id: Id9a50447160ca14c3fd3117957ba2263cdb00471 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8997 Community-CI: Broadcom CI Reviewed-by: Ben Walker Reviewed-by: Jim Harris Reviewed-by: Aleksey Marchuk Reviewed-by: Tomasz Zawadzki Tested-by: SPDK CI Jenkins --- doc/ftl.md | 44 ++++++++++++++++++++++---------------------- doc/spdkcli.md | 4 ++-- mdl_rules.rb | 1 - 3 files changed, 24 insertions(+), 25 deletions(-) diff --git a/doc/ftl.md b/doc/ftl.md index aa780d33b5..955ccf5923 100644 --- a/doc/ftl.md +++ b/doc/ftl.md @@ -9,7 +9,7 @@ media management events, and manages the defragmentation process. ## Logical to physical address map - * Shorthand: L2P +- Shorthand: L2P Contains the mapping of the logical addresses (LBA) to their on-disk physical location. The LBAs are contiguous and in range from 0 to the number of surfaced blocks (the number of spare blocks @@ -53,9 +53,9 @@ metadata is split in two parts: |block 1| |block 1| | |block x| | | |block y |block y| +-------------------+-------------+-----------------+------------------------+ - * the head part, containing information already known when opening the band (device's UUID, band's - 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. +- the head part, containing information already known when opening the band (device's UUID, band's + 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. 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` @@ -66,7 +66,7 @@ band. Once the whole available space is filled, tail metadata is written and the ## Ring write buffer {#ftl_rwb} - * Shorthand: RWB +- Shorthand: RWB Because the smallest write size the SSD may support can be a multiple of block size, in order to support writes to a single block, the data needs to be buffered. The write buffer is the solution to @@ -99,7 +99,7 @@ servicing read requests from the buffer. ## Defragmentation and relocation {#ftl_reloc} - * Shorthand: defrag, reloc +- Shorthand: defrag, reloc Since a write to the same LBA invalidates its previous physical location, some of the blocks on a band might contain old data that basically wastes space. As there is no way to overwrite an already @@ -146,9 +146,9 @@ Similar to other bdevs, the FTL bdevs can be created either based on JSON config Both interfaces require the same arguments which are described by the `--help` option of the `bdev_ftl_create` RPC call, which are: - - bdev's name - - base bdev's name (base bdev must implement bdev_zone API) - - UUID of the FTL device (if the FTL is to be restored from the SSD) +- bdev's name +- base bdev's name (base bdev must implement bdev_zone API) +- UUID of the FTL device (if the FTL is to be restored from the SSD) ## FTL usage with OCSSD nvme bdev {#ftl_ocssd} @@ -162,19 +162,19 @@ on [spdk-3.0.0](https://github.com/spdk/qemu/tree/spdk-3.0.0) branch. To emulate an Open Channel device, QEMU expects parameters describing the characteristics and geometry of the SSD: - - `serial` - serial number, - - `lver` - version of the OCSSD standard (0 - disabled, 1 - "1.2", 2 - "2.0"), libftl only supports - 2.0, - - `lba_index` - default LBA format. Possible values can be found in the table below (libftl only supports lba_index >= 3): - - `lnum_ch` - number of groups, - - `lnum_lun` - number of parallel units - - `lnum_pln` - number of planes (logical blocks from all planes constitute a chunk) - - `lpgs_per_blk` - number of pages (smallest programmable unit) per chunk - - `lsecs_per_pg` - number of sectors in a page - - `lblks_per_pln` - number of chunks in a parallel unit - - `laer_thread_sleep` - timeout in ms between asynchronous events requesting the host to relocate - the data based on media feedback - - `lmetadata` - metadata file +- `serial` - serial number, +- `lver` - version of the OCSSD standard (0 - disabled, 1 - "1.2", 2 - "2.0"), libftl only supports + 2.0, +- `lba_index` - default LBA format. Possible values can be found in the table below (libftl only supports lba_index >= 3): +- `lnum_ch` - number of groups, +- `lnum_lun` - number of parallel units +- `lnum_pln` - number of planes (logical blocks from all planes constitute a chunk) +- `lpgs_per_blk` - number of pages (smallest programmable unit) per chunk +- `lsecs_per_pg` - number of sectors in a page +- `lblks_per_pln` - number of chunks in a parallel unit +- `laer_thread_sleep` - timeout in ms between asynchronous events requesting the host to relocate + the data based on media feedback +- `lmetadata` - metadata file |lba_index| data| metadata| |---------|-----|---------| diff --git a/doc/spdkcli.md b/doc/spdkcli.md index fa3cd8cab8..74cc26dbb8 100644 --- a/doc/spdkcli.md +++ b/doc/spdkcli.md @@ -12,7 +12,7 @@ for the next SPDK release. All dependencies should be handled by scripts/pkgdep.sh script. Package dependencies at the moment include: - - configshell +- configshell ## Run SPDK application instance @@ -33,7 +33,7 @@ Use "help" command to get a list of available commands for each tree node. It is also possible to use SPDK CLI to run just a single command, just use the command as an argument to the application. For example, to view current configuration and immediately exit: - ~~~{.sh} +~~~{.sh} scripts/spdkcli.py ls ~~~ diff --git a/mdl_rules.rb b/mdl_rules.rb index 2dbed27036..8c9790bd6c 100644 --- a/mdl_rules.rb +++ b/mdl_rules.rb @@ -1,7 +1,6 @@ all exclude_rule 'MD003' exclude_rule 'MD004' -exclude_rule 'MD006' exclude_rule 'MD007' exclude_rule 'MD009' exclude_rule 'MD010'