Commit 3bc950c3 authored by David S. Miller's avatar David S. Miller

Merge branch 'docs-Convert-alias-and-bridge-to-rst'

Tobin C. Harding says:

====================
docs: Convert alias and bridge to rst

Here is my first attempt at working on converting docs in
Documentation/networking to rst format.  I've picked a couple of trivial
ones to start with.  If there is anything extra I can do to make your
life easier during documentation conversion please say.  (Also if there
is some reason that it would be preferable to _not_ embark on this task
please say :)

This set does not make any changes to the converted files apart from
formatting.

v2:
 - remove incorrect patch from set (changing 'Indices' indentation)
====================
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents f15f084f 6b335f82
...@@ -18,8 +18,6 @@ README.ipw2200 ...@@ -18,8 +18,6 @@ README.ipw2200
- README for the Intel PRO/Wireless 2915ABG and 2200BG driver. - README for the Intel PRO/Wireless 2915ABG and 2200BG driver.
README.sb1000 README.sb1000
- info on General Instrument/NextLevel SURFboard1000 cable modem. - info on General Instrument/NextLevel SURFboard1000 cable modem.
alias.txt
- info on using alias network devices.
altera_tse.txt altera_tse.txt
- Altera Triple-Speed Ethernet controller. - Altera Triple-Speed Ethernet controller.
arcnet-hardware.txt arcnet-hardware.txt
......
.. SPDX-License-Identifier: GPL-2.0
===========
IP-Aliasing
===========
IP-aliases are an obsolete way to manage multiple IP-addresses/masks
per interface. Newer tools such as iproute2 support multiple
address/prefixes per interface, but aliases are still supported
for backwards compatibility.
An alias is formed by adding a colon and a string when running ifconfig.
This string is usually numeric, but this is not a must.
Alias creation
==============
Alias creation is done by 'magic' interface naming: eg. to create a
200.1.1.1 alias for eth0 ...
::
# ifconfig eth0:0 200.1.1.1 etc,etc....
~~ -> request alias #0 creation (if not yet exists) for eth0
The corresponding route is also set up by this command. Please note:
The route always points to the base interface.
Alias deletion
==============
The alias is removed by shutting the alias down::
# ifconfig eth0:0 down
~~~~~~~~~~ -> will delete alias
Alias (re-)configuring
======================
Aliases are not real devices, but programs should be able to configure
and refer to them as usual (ifconfig, route, etc).
Relationship with main device
=============================
If the base device is shut down the added aliases will be deleted too.
IP-Aliasing:
============
IP-aliases are an obsolete way to manage multiple IP-addresses/masks
per interface. Newer tools such as iproute2 support multiple
address/prefixes per interface, but aliases are still supported
for backwards compatibility.
An alias is formed by adding a colon and a string when running ifconfig.
This string is usually numeric, but this is not a must.
o Alias creation.
Alias creation is done by 'magic' interface naming: eg. to create a
200.1.1.1 alias for eth0 ...
# ifconfig eth0:0 200.1.1.1 etc,etc....
~~ -> request alias #0 creation (if not yet exists) for eth0
The corresponding route is also set up by this command.
Please note: The route always points to the base interface.
o Alias deletion.
The alias is removed by shutting the alias down:
# ifconfig eth0:0 down
~~~~~~~~~~ -> will delete alias
o Alias (re-)configuring
Aliases are not real devices, but programs should be able to configure and
refer to them as usual (ifconfig, route, etc).
o Relationship with main device
If the base device is shut down the added aliases will be deleted
too.
.. SPDX-License-Identifier: GPL-2.0
=================
Ethernet Bridging
=================
In order to use the Ethernet bridging functionality, you'll need the In order to use the Ethernet bridging functionality, you'll need the
userspace tools. userspace tools.
......
...@@ -17,6 +17,8 @@ Contents: ...@@ -17,6 +17,8 @@ Contents:
msg_zerocopy msg_zerocopy
failover failover
net_failover net_failover
alias
bridge
.. only:: subproject .. only:: subproject
......
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