Commit 8523d5d4 authored by Konrad Sztyber's avatar Konrad Sztyber Committed by Tomasz Zawadzki
Browse files

check_format: update markdown rules



Disabled MD014, which says that command-line examples should either not
have the dollar sign or always show the output of the command.  This
means that if the whole document uses dollar sign before each command
and one of them doesn't print out anything, it should be removed from
that command, which makes very little sense to me.

Also, disabled line length checks for code blocks, as they can include
the output from commands which can be larger than the 170 limit that we
currently have.  Note that pkgdep installs the v0.11.0 version of
markdownlint where this option is called code_blocks (and needs to be
set to true to disable the checks).  Later versions deprecated this
option in favor of ignore_code_blocks (which has the reverse logic), but
v0.11.0 doesn't have it.

Change-Id: I5891ba78095df169df91da018194d36e3ab2c911
Signed-off-by: default avatarKonrad Sztyber <ksztyber@nvidia.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/26022


Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz@tzawadzki.com>
Reviewed-by: default avatarMateusz Kozlowski <mateusz.kozlowski@solidigm.com>
parent 1ca1a8c7
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ all
exclude_rule 'MD004'
rule 'MD007', :indent => 2
exclude_rule 'MD010'
rule 'MD013', :line_length => 170
rule 'MD013', :line_length => 170, :code_blocks => false
exclude_rule 'MD014'
exclude_rule 'MD024'
rule 'MD029', :style => "ordered"
exclude_rule 'MD031'