Commit 805f16a5 authored by Tobin C. Harding's avatar Tobin C. Harding Committed by David S. Miller
Browse files

Documentation: e1000: Fix docs build error 



Recent patch updated e1000 docs to rst format.  Docs build (`make
htmldocs`) is currently failing due to this file with error:

        (SEVERE/4) Unexpected section title.

This is because a section of the file is indented 2 spaces.  Build error
can be cleared by aligning the text with column 0.  While we are changing
these lines we can make sure line length does not exceed 72, that
newlines following headings are uniform, and that full stops are
followed by two spaces.

Align text with column 0, limit line length to 72, ensure two spaces
follow all full stops, ensure uniform use of newlines after heading.

Fixes commit (228046e7 Documentation: e1000: Update kernel documentation)

CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: default avatarTobin C. Harding <me@tobin.cc>
Acked-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 3b0c3ebe

Documentation/networking/e1000.rst

+38 −37
Original line number Original line Diff line number Diff line
@@ -357,9 +357,9 @@ Additional Configurations 




Jumbo Frames

Jumbo Frames

------------

------------

  Jumbo Frames support is enabled by changing the MTU to a value larger than

Jumbo Frames support is enabled by changing the MTU to a value larger

  the default of 1500.  Use the ifconfig command to increase the MTU size.

than the default of 1500.  Use the ifconfig command to increase the MTU

  For example::

size.  For example::





       ifconfig eth<x> mtu 9000 up

       ifconfig eth<x> mtu 9000 up
@@ -372,23 +372,23 @@ Additional Configurations 
applies to the Red Hat distributions; other distributions may store this

applies to the Red Hat distributions; other distributions may store this

setting in a different location.

setting in a different location.





  Notes:

Notes: Degradation in throughput performance may be observed in some

  Degradation in throughput performance may be observed in some Jumbo frames

Jumbo frames environments.  If this is observed, increasing the

  environments. If this is observed, increasing the application's socket buffer

application's socket buffer size and/or increasing the

  size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help.

/proc/sys/net/ipv4/tcp_*mem entry values may help.  See the specific

  See the specific application manual and /usr/src/linux*/Documentation/

application manual and /usr/src/linux*/Documentation/

networking/ip-sysctl.txt for more details.

networking/ip-sysctl.txt for more details.





  - The maximum MTU setting for Jumbo Frames is 16110.  This value coincides

- The maximum MTU setting for Jumbo Frames is 16110.  This value

    with the maximum Jumbo Frames size of 16128.

  coincides with the maximum Jumbo Frames size of 16128.





  - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in

- Using Jumbo frames at 10 or 100 Mbps is not supported and may result

    poor performance or loss of link.

  in poor performance or loss of link.





- Adapters based on the Intel(R) 82542 and 82573V/E controller do not

- Adapters based on the Intel(R) 82542 and 82573V/E controller do not

  support Jumbo Frames.  These correspond to the following product names:

  support Jumbo Frames.  These correspond to the following product names:

     Intel(R) PRO/1000 Gigabit Server Adapter

  Intel(R) PRO/1000 Gigabit Server Adapter Intel(R) PRO/1000 PM Network

     Intel(R) PRO/1000 PM Network Connection

  Connection





ethtool

ethtool

-------

-------
@@ -407,6 +407,7 @@ Additional Configurations 
For this driver version, in order to enable WoL, the e1000 driver must be

For this driver version, in order to enable WoL, the e1000 driver must be

loaded when shutting down or rebooting the system.

loaded when shutting down or rebooting the system.







Support

Support

=======

=======

CRA Git | Maintained and supported by SUSTech CRA and CCSE