Skip to content

Commit

Permalink
docs: networking: Convert alias.txt to rst
Browse files Browse the repository at this point in the history
The kernel documentation is now restructured text. Convert the IP
aliasing documentation and include it in the toplevel kernel
documentation.

 - Fix heading adornments.
 - Correctly indent code snippets.
 - Limit line length to 72 characters inline with kernel documentation
   standards.
 - Add license identifier.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
tcharding authored and davem330 committed Jul 18, 2018
1 parent f15f084 commit 735dadf
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 42 deletions.
2 changes: 0 additions & 2 deletions Documentation/networking/00-INDEX
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ README.ipw2200
- README for the Intel PRO/Wireless 2915ABG and 2200BG driver.
README.sb1000
- info on General Instrument/NextLevel SURFboard1000 cable modem.
alias.txt
- info on using alias network devices.
altera_tse.txt
- Altera Triple-Speed Ethernet controller.
arcnet-hardware.txt
Expand Down
49 changes: 49 additions & 0 deletions Documentation/networking/alias.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. 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.
40 changes: 0 additions & 40 deletions Documentation/networking/alias.txt

This file was deleted.

1 change: 1 addition & 0 deletions Documentation/networking/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Contents:
msg_zerocopy
failover
net_failover
alias

.. only:: subproject

Expand Down

0 comments on commit 735dadf

Please sign in to comment.