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

markdownlint: enable rule MD006 



MD006 - Consider starting bulleted lists at the beginning of the line
Fixed all errors

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


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 1df1583b

doc/ftl.md

+22 −22
Original line number Diff line number Diff line
@@ -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

- 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 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

mdl_rules.rb

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

exclude_rule 'MD003'

exclude_rule 'MD004'

exclude_rule 'MD006'

exclude_rule 'MD007'

exclude_rule 'MD009'

exclude_rule 'MD010'

doc/spdkcli.md

+2 −2

File changed.

Contains only whitespace changes.