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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20221121035854.28411-1-bagasdotme@gmail.com>
Date:   Mon, 21 Nov 2022 10:58:55 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     netdev@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, oe-kbuild-all@...ts.linux.dev,
        GNU/Weeb Mailing List <gwml@...r.gnuweeb.org>,
        kernel test robot <lkp@...el.com>
Cc:     Jiri Pirko <jiri@...dia.com>,
        "David S. Miller" <davem@...emloft.net>,
        Eric Dumazet <edumazet@...gle.com>,
        Jakub Kicinski <kuba@...nel.org>,
        Paolo Abeni <pabeni@...hat.com>,
        Jonathan Corbet <corbet@....net>,
        Michal Wilczynski <michal.wilczynski@...el.com>,
        Ammar Faizi <ammarfaizi2@...weeb.org>,
        Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH net-next] Documentation: devlink: Add blank line padding on numbered lists in Devlink 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/202211200926.kfOPiVti-lkp@intel.com/
Fixes: 242dd64375b80a ("Documentation: Add documentation for new devlink-rate attributes")
Reported-by: kernel test robot <lkp@...el.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/networking/devlink/devlink-port.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

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.
 

base-commit: 8bd8dcc5e47f0f9dc40187c3b8b42d992181eee1
-- 
An old man doll... just what I always wanted! - Clara