linux-kernel - RE: [PATCH] net: fix e1000.rst Documentation build errors

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]

Date:   Mon, 18 Jun 2018 19:42:37 +0000
From:   "Brown, Aaron F" <aaron.f.brown@...el.com>
To:     Randy Dunlap <rdunlap@...radead.org>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        David Miller <davem@...emloft.net>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>
CC:     LKML <linux-kernel@...r.kernel.org>,
        "Kirsher, Jeffrey T" <jeffrey.t.kirsher@...el.com>
Subject: RE: [PATCH] net: fix e1000.rst Documentation build errors

> From: Randy Dunlap [mailto:rdunlap@...radead.org]
> Sent: Saturday, June 16, 2018 5:36 PM
> To: netdev@...r.kernel.org; David Miller <davem@...emloft.net>; linux-
> doc@...r.kernel.org
> Cc: LKML <linux-kernel@...r.kernel.org>; Kirsher, Jeffrey T
> <jeffrey.t.kirsher@...el.com>; Brown, Aaron F <aaron.f.brown@...el.com>
> Subject: [PATCH] net: fix e1000.rst Documentation build errors
> 
> From: Randy Dunlap <rdunlap@...radead.org>
> 
> Fix Documentation build errors in e1000.rst.  Several section titles and
> their underlines should not be indented.
> 
> Documentation/networking/e1000.rst:358: (SEVERE/4) Unexpected section
> title.
> 
> Fixes: 228046e76189 ("Documentation: e1000: Update kernel
> documentation")
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Jeff Kirsher <jeffrey.t.kirsher@...el.com>
> Cc: Aaron Brown <aaron.f.brown@...el.com>
> ---
> Is there a Sphinx version problem here?  Tested-by: should indicate
> that there was no error like I am seeing. 

The "Tested-by:" for this (and the e100 variant) was entirely focused on correctness of the documentation text, parameters match the driver, URLs were correct, etc...  In retrospect "Tested-by:" is not exactly accurate and I probably should have left it at a simpler ack.

> 
>  Documentation/networking/e1000.rst |   12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> --- lnx-418-rc1.orig/Documentation/networking/e1000.rst
> +++ lnx-418-rc1/Documentation/networking/e1000.rst
> @@ -354,8 +354,8 @@ previously mentioned to force the adapte
>  Additional Configurations
>  =========================
> 
> -  Jumbo Frames
> -  ------------
> +Jumbo Frames
> +------------
>    Jumbo Frames support is enabled by changing the MTU to a value larger
> than
>    the default of 1500.  Use the ifconfig command to increase the MTU size.
>    For example::
> @@ -389,8 +389,8 @@ Additional Configurations
>       Intel(R) PRO/1000 Gigabit Server Adapter
>       Intel(R) PRO/1000 PM Network Connection
> 
> -  ethtool
> -  -------
> +ethtool
> +-------
>    The driver utilizes the ethtool interface for driver configuration and
>    diagnostics, as well as displaying statistical information.  The ethtool
>    version 1.6 or later is required for this functionality.
> @@ -398,8 +398,8 @@ Additional Configurations
>    The latest release of ethtool can be found from
>    https://www.kernel.org/pub/software/network/ethtool/
> 
> -  Enabling Wake on LAN* (WoL)
> -  ---------------------------
> +Enabling Wake on LAN* (WoL)
> +---------------------------
>    WoL is configured through the ethtool* utility.
> 
>    WoL will be enabled on the system during the next shut down or reboot.
>