Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

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

Documentation/networking/e100.rst

+58 −57
Original line number Diff line number Diff line
@@ -90,27 +90,30 @@ Additional Configurations 
Configuring the Driver on Different Distributions

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



  Configuring a network driver to load properly when the system is started is

  distribution dependent. Typically, the configuration process involves adding

  an alias line to /etc/modprobe.d/*.conf as well as editing other system

  startup scripts and/or configuration files.  Many popular Linux

  distributions ship with tools to make these changes for you. To learn the

  proper way to configure a network device for your system, refer to your

  distribution documentation.  If during this process you are asked for the

  driver or module name, the name for the Linux Base Driver for the Intel

  PRO/100 Family of Adapters is e100.

Configuring a network driver to load properly when the system is started

is distribution dependent.  Typically, the configuration process involves

adding an alias line to /etc/modprobe.d/*.conf as well as editing other

system startup scripts and/or configuration files.  Many popular Linux

distributions ship with tools to make these changes for you.  To learn

the proper way to configure a network device for your system, refer to

your distribution documentation.  If during this process you are asked

for the driver or module name, the name for the Linux Base Driver for

the Intel PRO/100 Family of Adapters is e100.



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 eth1 e100



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::

entering the following on the command line before loading the e100

driver::



       dmesg -n 6
@@ -119,7 +122,6 @@ Additional Configurations 


NOTE: This setting is not saved across reboots.





ethtool

-------
@@ -132,26 +134,25 @@ Additional Configurations 


Enabling Wake on LAN* (WoL)

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

  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.

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 (Rx polling mode) is supported in the e100 driver.



  See https://wiki.linuxfoundation.org/networking/napi for more information

  on NAPI.

See https://wiki.linuxfoundation.org/networking/napi for more

information on NAPI.



Multiple Interfaces on Same Ethernet Broadcast Network

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



  Due to the default ARP behavior on Linux, it is not possible to have

  one system on two IP networks in the same Ethernet broadcast domain

Due to the default ARP behavior on Linux, it is not possible to have one

system on two IP networks in the same Ethernet broadcast domain

(non-partitioned switch) behave as expected.  All Ethernet interfaces

will respond to IP traffic for any IP address assigned to the system.

This results in unbalanced receive traffic.