linux-kernel - Re: [PATCH 1/3] doc: networking: prepare scaling document for conversion into RST

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-prev] [day] [month] [year] [list]

Message-ID: <20190116150307.67eb2201@lwn.net>
Date:   Wed, 16 Jan 2019 15:03:07 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Otto Sabart <ottosabart@...erm.com>
Cc:     linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        netdev@...r.kernel.org, "David S. Miller" <davem@...emloft.net>
Subject: Re: [PATCH 1/3] doc: networking: prepare scaling document for
 conversion into RST

On Wed, 9 Jan 2019 20:57:22 +0100
Otto Sabart <ottosabart@...erm.com> wrote:

> Add markups which are necessary for successful conversion into
> reStructuredText.
> 
> There are no semantic changes.
> 
> Signed-off-by: Otto Sabart <ottosabart@...erm.com>

This seems generally good, except:

>  Documentation/networking/scaling.txt | 131 +++++++++++++++++----------
>  1 file changed, 85 insertions(+), 46 deletions(-)
> 
> diff --git a/Documentation/networking/scaling.txt b/Documentation/networking/scaling.txt
> index b7056a8a0540..0ce13ed103bd 100644
> --- a/Documentation/networking/scaling.txt
> +++ b/Documentation/networking/scaling.txt
> @@ -1,4 +1,8 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=====================================
>  Scaling in the Linux Networking Stack
> +=====================================
>  
>  
>  Introduction
> @@ -10,11 +14,11 @@ multi-processor systems.
>  
>  The following technologies are described:
>  
> -  RSS: Receive Side Scaling
> -  RPS: Receive Packet Steering
> -  RFS: Receive Flow Steering
> -  Accelerated Receive Flow Steering
> -  XPS: Transmit Packet Steering
> +- RSS: Receive Side Scaling
> +- RPS: Receive Packet Steering
> +- RFS: Receive Flow Steering
> +- Accelerated Receive Flow Steering
> +- XPS: Transmit Packet Steering
>  
>  
>  RSS: Receive Side Scaling
> @@ -45,7 +49,9 @@ programmable filters. For example, webserver bound TCP port 80 packets
>  can be directed to their own receive queue. Such “n-tuple” filters can
>  be configured from ethtool (--config-ntuple).
>  
> -==== RSS Configuration
> +
> +RSS Configuration
> +`````````````````

The use of the heading levels is kind of strange; I'm not really sure why
you did it that way?  I'd rather this adhered to our normal hierarchy, so
it should be:

   RSS Configuration
   -----------------

All of the other bottom-level headings should be as well.

Fix that up, please, and I can take these.  The whole series can also be
squashed into a single patch (though I don't feel really strongly about
that either way).

Thanks,

jon