ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

markdownlint: enable rule MD001

Browse Source 
MD001 - Header levels should only increment by one level at a time
Fixed all MD001 errors

Signed-off-by: wawryk <maciejx.wawryk@intel.com>
Change-Id: I6c0d711b30246e8a9d00bc991edbf34c3cf68805
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8939
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
This commit is contained in:
wawryk 2021-07-27 12:14:02 +02:00 committed by Tomasz Zawadzki
parent 12fcbc9b94
commit 3f944e495a
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/spdkcli.md
View File

@ -7,21 +7,21 @@ This experimental version was added for v18.04 to get early feedback
that can be incorporated as spdkcli becomes more fully-featured that can be incorporated as spdkcli becomes more fully-featured
for the next SPDK release. for the next SPDK release.
### Install needed dependencies ## Install needed dependencies
All dependencies should be handled by scripts/pkgdep.sh script. All dependencies should be handled by scripts/pkgdep.sh script.
Package dependencies at the moment include: Package dependencies at the moment include:
- configshell - configshell
### Run SPDK application instance ## Run SPDK application instance
~~~{.sh} ~~~{.sh}
./scripts/setup.sh ./scripts/setup.sh
./build/bin/vhost -c vhost.json ./build/bin/vhost -c vhost.json
~~~ ~~~
### Run SPDK CLI ## Run SPDK CLI
Spdkcli should be run with the same privileges as SPDK application. Spdkcli should be run with the same privileges as SPDK application.
In order to use SPDK CLI in interactive mode please use: In order to use SPDK CLI in interactive mode please use:
@ -37,7 +37,7 @@ For example, to view current configuration and immediately exit:
scripts/spdkcli.py ls scripts/spdkcli.py ls
~~~ ~~~
### Optional - create Python virtual environment ## Optional - create Python virtual environment
You can use Python virtual environment if you don't want to litter your You can use Python virtual environment if you don't want to litter your
system Python installation. system Python installation.

1
mdl_rules.rb
View File

@ -1,5 +1,4 @@
all all
exclude_rule 'MD001'
exclude_rule 'MD002' exclude_rule 'MD002'
exclude_rule 'MD003' exclude_rule 'MD003'
exclude_rule 'MD004' exclude_rule 'MD004'