Commit 3b0c3ebe authored by Tobin C. Harding's avatar Tobin C. Harding Committed by David S. Miller

Documentation: e100: Fix docs build error

Recent patch updated e100 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 (85d63445 Documentation: e100: Update the Intel 10/100 driver doc)

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 3be40e54
...@@ -87,83 +87,84 @@ Event Log Message Level: The driver uses the message level flag to log events ...@@ -87,83 +87,84 @@ Event Log Message Level: The driver uses the message level flag to log events
Additional Configurations Additional Configurations
========================= =========================
Configuring the Driver on Different Distributions Configuring the Driver on Different Distributions
------------------------------------------------- -------------------------------------------------
Configuring a network driver to load properly when the system is started is Configuring a network driver to load properly when the system is started
distribution dependent. Typically, the configuration process involves adding is distribution dependent. Typically, the configuration process involves
an alias line to /etc/modprobe.d/*.conf as well as editing other system adding an alias line to /etc/modprobe.d/*.conf as well as editing other
startup scripts and/or configuration files. Many popular Linux system startup scripts and/or configuration files. Many popular Linux
distributions ship with tools to make these changes for you. To learn the distributions ship with tools to make these changes for you. To learn
proper way to configure a network device for your system, refer to your the proper way to configure a network device for your system, refer to
distribution documentation. If during this process you are asked for the your distribution documentation. If during this process you are asked
driver or module name, the name for the Linux Base Driver for the Intel for the driver or module name, the name for the Linux Base Driver for
PRO/100 Family of Adapters is e100. the Intel PRO/100 Family of Adapters is e100.
As an example, if you install the e100 driver for two PRO/100 adapters As an example, if you install the e100 driver for two PRO/100 adapters
(eth0 and eth1), add the following to a configuration file in /etc/modprobe.d/ (eth0 and eth1), add the following to a configuration file in
/etc/modprobe.d/::
alias eth0 e100 alias eth0 e100
alias eth1 e100 alias eth1 e100
Viewing Link Messages Viewing Link Messages
--------------------- ---------------------
In order to see link messages and other Intel driver information on your
console, you must set the dmesg level up to six. This can be done by
entering the following on the command line before loading the e100 driver::
dmesg -n 6 In order to see link messages and other Intel driver information on your
console, you must set the dmesg level up to six. This can be done by
If you wish to see all messages issued by the driver, including debug entering the following on the command line before loading the e100
messages, set the dmesg level to eight. driver::
NOTE: This setting is not saved across reboots. dmesg -n 6
If you wish to see all messages issued by the driver, including debug
messages, set the dmesg level to eight.
ethtool NOTE: This setting is not saved across reboots.
-------
The driver utilizes the ethtool interface for driver configuration and ethtool
diagnostics, as well as displaying statistical information. The ethtool -------
version 1.6 or later is required for this functionality.
The latest release of ethtool can be found from The driver utilizes the ethtool interface for driver configuration and
https://www.kernel.org/pub/software/network/ethtool/ diagnostics, as well as displaying statistical information. The ethtool
version 1.6 or later is required for this functionality.
Enabling Wake on LAN* (WoL) The latest release of ethtool can be found from
--------------------------- https://www.kernel.org/pub/software/network/ethtool/
WoL is provided through the ethtool* utility. For instructions on enabling
WoL with ethtool, refer to the ethtool man page.
WoL will be enabled on the system during the next shut down or reboot. For Enabling Wake on LAN* (WoL)
this driver version, in order to enable WoL, the e100 driver must be ---------------------------
loaded when shutting down or rebooting the system. WoL is provided through the ethtool* utility. For instructions on
enabling WoL with ethtool, refer to the ethtool man page. WoL will be
enabled on the system during the next shut down or reboot. For this
driver version, in order to enable WoL, the e100 driver must be loaded
when shutting down or rebooting the system.
NAPI NAPI
---- ----
NAPI (Rx polling mode) is supported in the e100 driver. NAPI (Rx polling mode) is supported in the e100 driver.
See https://wiki.linuxfoundation.org/networking/napi for more information See https://wiki.linuxfoundation.org/networking/napi for more
on NAPI. information on NAPI.
Multiple Interfaces on Same Ethernet Broadcast Network Multiple Interfaces on Same Ethernet Broadcast Network
------------------------------------------------------ ------------------------------------------------------
Due to the default ARP behavior on Linux, it is not possible to have Due to the default ARP behavior on Linux, it is not possible to have one
one system on two IP networks in the same Ethernet broadcast domain system on two IP networks in the same Ethernet broadcast domain
(non-partitioned switch) behave as expected. All Ethernet interfaces (non-partitioned switch) behave as expected. All Ethernet interfaces
will respond to IP traffic for any IP address assigned to the system. will respond to IP traffic for any IP address assigned to the system.
This results in unbalanced receive traffic. This results in unbalanced receive traffic.
If you have multiple interfaces in a server, either turn on ARP If you have multiple interfaces in a server, either turn on ARP
filtering by filtering by
(1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter (1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
(this only works if your kernel's version is higher than 2.4.5), or (this only works if your kernel's version is higher than 2.4.5), or
(2) installing the interfaces in separate broadcast domains (either (2) installing the interfaces in separate broadcast domains (either
in different switches or in a switch partitioned to VLANs). in different switches or in a switch partitioned to VLANs).
Support Support
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment