Skip to content

Commit

Permalink
Documentation: devlink: Add blank line padding on numbered lists in D…
Browse files Browse the repository at this point in the history
…evlink Port documentation

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/[email protected]/
Fixes: 242dd64 ("Documentation: Add documentation for new devlink-rate attributes")
Reported-by: kernel test robot <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
Signed-off-by: David S. Miller <[email protected]>
  • Loading branch information
bagasme authored and davem330 committed Nov 23, 2022
1 parent af42736 commit c84f6f6
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions Documentation/networking/devlink/devlink-port.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit c84f6f6

Please sign in to comment.