aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobin C. Harding <me@tobin.cc>2018-06-21 20:37:08 -0400
committerDavid S. Miller <davem@davemloft.net>2018-06-22 21:37:37 -0400
commit805f16a5f12fd68e10841013ccfaceb2f4d7066a (patch)
treed07fb60ad57ca17fd1a4a7e38ae2c5ee4d38f3ec
parent3b0c3ebe2a42ce18a59828acc4578166367dc7b5 (diff)
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 (228046e76189 Documentation: e1000: Update kernel documentation) CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com> Signed-off-by: Tobin C. Harding <me@tobin.cc> Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net>
-rw-r--r--Documentation/networking/e1000.rst75
1 files changed, 38 insertions, 37 deletions
diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst
index 55f28e5043b6..144b87eef153 100644
--- a/Documentation/networking/e1000.rst
+++ b/Documentation/networking/e1000.rst
@@ -355,57 +355,58 @@ previously mentioned to force the adapter to the same speed and duplex.
355Additional Configurations 355Additional Configurations
356========================= 356=========================
357 357
358 Jumbo Frames 358Jumbo Frames
359 ------------ 359------------
360 Jumbo Frames support is enabled by changing the MTU to a value larger than 360Jumbo Frames support is enabled by changing the MTU to a value larger
361 the default of 1500. Use the ifconfig command to increase the MTU size. 361than the default of 1500. Use the ifconfig command to increase the MTU
362 For example:: 362size. For example::
363 363
364 ifconfig eth<x> mtu 9000 up 364 ifconfig eth<x> mtu 9000 up
365 365
366 This setting is not saved across reboots. It can be made permanent if 366This setting is not saved across reboots. It can be made permanent if
367 you add:: 367you add::
368 368
369 MTU=9000 369 MTU=9000
370 370
371 to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example 371to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example
372 applies to the Red Hat distributions; other distributions may store this 372applies to the Red Hat distributions; other distributions may store this
373 setting in a different location. 373setting in a different location.
374 374
375 Notes: 375Notes: Degradation in throughput performance may be observed in some
376 Degradation in throughput performance may be observed in some Jumbo frames 376Jumbo frames environments. If this is observed, increasing the
377 environments. If this is observed, increasing the application's socket buffer 377application's socket buffer size and/or increasing the
378 size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help. 378/proc/sys/net/ipv4/tcp_*mem entry values may help. See the specific
379 See the specific application manual and /usr/src/linux*/Documentation/ 379application manual and /usr/src/linux*/Documentation/
380 networking/ip-sysctl.txt for more details. 380networking/ip-sysctl.txt for more details.
381 381
382 - The maximum MTU setting for Jumbo Frames is 16110. This value coincides 382- The maximum MTU setting for Jumbo Frames is 16110. This value
383 with the maximum Jumbo Frames size of 16128. 383 coincides with the maximum Jumbo Frames size of 16128.
384 384
385 - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in 385- Using Jumbo frames at 10 or 100 Mbps is not supported and may result
386 poor performance or loss of link. 386 in poor performance or loss of link.
387 387
388 - Adapters based on the Intel(R) 82542 and 82573V/E controller do not 388- Adapters based on the Intel(R) 82542 and 82573V/E controller do not
389 support Jumbo Frames. These correspond to the following product names: 389 support Jumbo Frames. These correspond to the following product names:
390 Intel(R) PRO/1000 Gigabit Server Adapter 390 Intel(R) PRO/1000 Gigabit Server Adapter Intel(R) PRO/1000 PM Network
391 Intel(R) PRO/1000 PM Network Connection 391 Connection
392 392
393 ethtool 393ethtool
394 ------- 394-------
395 The driver utilizes the ethtool interface for driver configuration and 395The driver utilizes the ethtool interface for driver configuration and
396 diagnostics, as well as displaying statistical information. The ethtool 396diagnostics, as well as displaying statistical information. The ethtool
397 version 1.6 or later is required for this functionality. 397version 1.6 or later is required for this functionality.
398
399The latest release of ethtool can be found from
400https://www.kernel.org/pub/software/network/ethtool/
398 401
399 The latest release of ethtool can be found from 402Enabling Wake on LAN* (WoL)
400 https://www.kernel.org/pub/software/network/ethtool/ 403---------------------------
404WoL is configured through the ethtool* utility.
401 405
402 Enabling Wake on LAN* (WoL) 406WoL will be enabled on the system during the next shut down or reboot.
403 --------------------------- 407For this driver version, in order to enable WoL, the e1000 driver must be
404 WoL is configured through the ethtool* utility. 408loaded when shutting down or rebooting the system.
405 409
406 WoL will be enabled on the system during the next shut down or reboot.
407 For this driver version, in order to enable WoL, the e1000 driver must be
408 loaded when shutting down or rebooting the system.
409 410
410Support 411Support
411======= 412=======