diff mbox series

[net-next] Documentation: devlink: Add blank line padding on numbered lists in Devlink Port documentation

Message ID 20221121035854.28411-1-bagasdotme@gmail.com (mailing list archive)
State Accepted
Commit c84f6f6c2bb5cd907cd1e770c5b29adb7bf2ae0e
Delegated to: Netdev Maintainers
Headers show
Series [net-next] Documentation: devlink: Add blank line padding on numbered lists in Devlink Port documentation | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers success CCed 9 of 9 maintainers
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch warning WARNING: Please use correct Fixes: style 'Fixes: <12 chars of sha1> ("<title line>")' - ie: 'Fixes: 242dd64375b8 ("Documentation: Add documentation for new devlink-rate attributes")'
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Bagas Sanjaya Nov. 21, 2022, 3:58 a.m. UTC 
kernel test robot reported indentation warnings:

Documentation/networking/devlink/devlink-port.rst:220: WARNING: Unexpected indentation.
Documentation/networking/devlink/devlink-port.rst:222: WARNING: Block quote ends without a blank line; unexpected unindent.

These warnings cause lists (arbitration flow for which the warnings blame to
and 3-step subfunction setup) to be rendered inline instead. Also, for the
former list, automatic list numbering is messed up.

Fix these warnings by adding missing blank line padding.

Link: https://lore.kernel.org/linux-doc/202211200926.kfOPiVti-lkp@intel.com/
Fixes: 242dd64375b80a ("Documentation: Add documentation for new devlink-rate attributes")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/networking/devlink/devlink-port.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)


base-commit: 8bd8dcc5e47f0f9dc40187c3b8b42d992181eee1

Comments

patchwork-bot+netdevbpf@kernel.org Nov. 23, 2022, 12:50 p.m. UTC | #1 
Hello:

This patch was applied to netdev/net-next.git (master)
by David S. Miller <davem@davemloft.net>:

On Mon, 21 Nov 2022 10:58:55 +0700 you wrote:
> kernel test robot reported indentation warnings:
> 
> Documentation/networking/devlink/devlink-port.rst:220: WARNING: Unexpected indentation.
> Documentation/networking/devlink/devlink-port.rst:222: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> These warnings cause lists (arbitration flow for which the warnings blame to
> and 3-step subfunction setup) to be rendered inline instead. Also, for the
> former list, automatic list numbering is messed up.
> 
> [...]

Here is the summary with links:
  - [net-next] Documentation: devlink: Add blank line padding on numbered lists in Devlink Port documentation
    https://git.kernel.org/netdev/net-next/c/c84f6f6c2bb5

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/networking/devlink/devlink-port.rst b/Documentation/networking/devlink/devlink-port.rst
index 643f5903d1d8aa..98557c2ab1c11f 100644
--- a/Documentation/networking/devlink/devlink-port.rst
+++ b/Documentation/networking/devlink/devlink-port.rst
@@ -130,10 +130,11 @@  it is deployed. Subfunction is created and deployed in unit of 1. Unlike
 SRIOV VFs, a subfunction doesn't require its own PCI virtual function.
 A subfunction communicates with the hardware through the parent PCI function.
 
-To use a subfunction, 3 steps setup sequence is followed.
-(1) create - create a subfunction;
-(2) configure - configure subfunction attributes;
-(3) deploy - deploy the subfunction;
+To use a subfunction, 3 steps setup sequence is followed:
+
+1) create - create a subfunction;
+2) configure - configure subfunction attributes;
+3) deploy - deploy the subfunction;
 
 Subfunction management is done using devlink port user interface.
 User performs setup on the subfunction management device.
@@ -216,13 +217,17 @@  nodes with the same priority form a WFQ subgroup in the sibling group
 and arbitration among them is based on assigned weights.
 
 Arbitration flow from the high level:
+
 #. Choose a node, or group of nodes with the highest priority that stays
    within the BW limit and are not blocked. Use ``tx_priority`` as a
    parameter for this arbitration.
+
 #. If group of nodes have the same priority perform WFQ arbitration on
    that subgroup. Use ``tx_weight`` as a parameter for this arbitration.
+
 #. Select the winner node, and continue arbitration flow among it's children,
    until leaf node is reached, and the winner is established.
+
 #. If all the nodes from the highest priority sub-group are satisfied, or
    overused their assigned BW, move to the lower priority nodes.