lkml.org 
[lkml]   [2018]   [Jun]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRE: [PATCH] net: fix e1000.rst Documentation build errors
Date
> From: Randy Dunlap [mailto:rdunlap@infradead.org]
> Sent: Saturday, June 16, 2018 5:36 PM
> To: netdev@vger.kernel.org; David Miller <davem@davemloft.net>; linux-
> doc@vger.kernel.org
> Cc: LKML <linux-kernel@vger.kernel.org>; Kirsher, Jeffrey T
> <jeffrey.t.kirsher@intel.com>; Brown, Aaron F <aaron.f.brown@intel.com>
> Subject: [PATCH] net: fix e1000.rst Documentation build errors
>
> From: Randy Dunlap <rdunlap@infradead.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@infradead.org>
> Cc: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> Cc: Aaron Brown <aaron.f.brown@intel.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.
>

\
 
 \ /
  Last update: 2018-06-18 21:43    [W:0.055 / U:0.800 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site