From 78d8ba2888c135ac928dc05524fa5f8b5e8fde57 Mon Sep 17 00:00:00 2001 From: wawryk Date: Mon, 2 Aug 2021 12:51:38 +0200 Subject: [PATCH] markdownlint: enable rule MD022 MD022 - Headers should be surrounded by blank lines Fixed all errors Signed-off-by: Maciej Wawryk Change-Id: I035778a9a1bb32107fb2018aec32a8d01e924dfb Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9040 Tested-by: SPDK CI Jenkins Community-CI: Broadcom CI Reviewed-by: Paul Luse Reviewed-by: Ben Walker Reviewed-by: Jim Harris Reviewed-by: Aleksey Marchuk --- doc/jsonrpc.md | 2 ++ doc/spdk_top.md | 6 ++++++ mdl_rules.rb | 1 - 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index f87c26fc52..3272886953 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -6954,6 +6954,7 @@ are 0. This rpc can only be invoked in STARTUP stage. All values are in units of 100 milliseconds (same as the NVMe specification). ### Parameters + Name | Optional | Type | Description ----------------------- | -------- | ----------- | ----------- crdt1 | Optional | number | Command Retry Delay Time 1 @@ -9072,6 +9073,7 @@ This method has no parameters. ### Response Completion status of enumeration is returned as a boolean. + ### Example Example request: diff --git a/doc/spdk_top.md b/doc/spdk_top.md index 36c657f096..ba67ba768b 100644 --- a/doc/spdk_top.md +++ b/doc/spdk_top.md @@ -16,6 +16,7 @@ This information enables users to identify CPU cores that are busy doing real wo needs more or less CPU resources. # Run spdk_top + Before running spdk_top you need to run the SPDK application whose performance you want to analyze using spdk_top. Run the spdk_top application @@ -25,6 +26,7 @@ Run the spdk_top application ~~~ # Bottom menu + Menu at the bottom of SPDK top window shows many options for changing displayed data. Each menu item has a key associated with it in square brackets. * Quit - quits the SPDK top application. @@ -35,6 +37,7 @@ of all available pages. * Help - displays help pop-up window. # Threads Tab + The threads tab displays a line item for each spdk thread. The information displayed shows: * Thread name - name of SPDK thread. @@ -50,6 +53,7 @@ Pop-up then can be closed by pressing ESC key. To learn more about spdk threads see @ref concurrency. # Pollers Tab + The pollers tab displays a line item for each poller. The information displayed shows: * Poller name - name of currently selected poller. @@ -64,6 +68,7 @@ Poller pop-up window can be displayed by pressing ENTER on a selected data row a Pop-up can be closed by pressing ESC key. # Cores Tab + The cores tab provides insights into how the application is using the CPU cores assigned to it. The information displayed for each core shows: * Core - core number. @@ -76,4 +81,5 @@ Pressing ENTER key makes a pop-up window appear, showing above information, alon window allows to select a thread and display thread details pop-up on top of it. To close both pop-ups use ESC key. # Help Window + Help window pop-up can be invoked by pressing H key inside any tab. It contains explanations for each key used inside the spdk_top application. diff --git a/mdl_rules.rb b/mdl_rules.rb index cf20e8af0b..e0089468fe 100644 --- a/mdl_rules.rb +++ b/mdl_rules.rb @@ -3,7 +3,6 @@ exclude_rule 'MD003' exclude_rule 'MD004' exclude_rule 'MD010' rule 'MD013', :line_length => 170 -exclude_rule 'MD022' exclude_rule 'MD023' exclude_rule 'MD024' exclude_rule 'MD025'