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: David S. Miller <davem@davemloft.net>
mariux64 · Jul 18, 2018 · 3bc950c · 3bc950c
2 parents f15f084 + 6b335f8
commit 3bc950c
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 42 deletions.
diff --git a/Documentation/networking/00-INDEX b/Documentation/networking/00-INDEX
@@ -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

diff --git a/Documentation/networking/alias.rst b/Documentation/networking/alias.rst
@@ -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.
diff --git a/Documentation/networking/alias.txt b/Documentation/networking/alias.txt
diff --git a/Documentation/networking/bridge.txt → Documentation/networking/bridge.rst b/Documentation/networking/bridge.txt → Documentation/networking/bridge.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================
+Ethernet Bridging
+=================
+
 In order to use the Ethernet bridging functionality, you'll need the
 userspace tools.
 

diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
@@ -17,6 +17,8 @@ Contents:
    msg_zerocopy
    failover
    net_failover
+   alias
+   bridge
 
 .. only::  subproject