docs: Convert alias and bridge to rst
Subsystems (3)
v2 cover docs: Convert alias and bridge to rst
Hi Dave,
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.
thanks,
Tobin.
v2:
- remove incorrect patch from set (changing 'Indices' indentation)
Tobin C. Harding (2):
docs: networking: Convert alias.txt to rst
docs: networking: Convert bridge.txt to rst
Documentation/networking/00-INDEX | 2 -
Documentation/networking/alias.rst | 49 +++++++++++++++++++
Documentation/networking/alias.txt | 40 ---------------
.../networking/{bridge.txt => bridge.rst} | 6 +++
Documentation/networking/index.rst | 2 +
5 files changed, 57 insertions(+), 42 deletions(-)
create mode 100644 Documentation/networking/alias.rst
delete mode 100644 Documentation/networking/alias.txt
rename Documentation/networking/{bridge.txt => bridge.rst} (85%)Signature · 1 line
2.17.1
PATCH v2 1/2 docs: networking: Convert alias.txt to rst
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.
--- Documentation/networking/00-INDEX | 2 -- Documentation/networking/alias.rst | 49 ++++++++++++++++++++++++++++++ Documentation/networking/alias.txt | 40 ------------------------ Documentation/networking/index.rst | 1 + 4 files changed, 50 insertions(+), 42 deletions(-) create mode 100644 Documentation/networking/alias.rst delete mode 100644 Documentation/networking/alias.txt
Documentation/networking/00-INDEX +0 -2
@@ -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
Documentation/networking/alias.rst new file +49 -0
49 lines not on this page · raw message
Documentation/networking/alias.txt deleted +0 -40
@@ -1,40 +0,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. - -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.
Documentation/networking/index.rst +1 -0
@@ -17,6 +17,7 @@ Contents: msg_zerocopy failover net_failover + alias .. only:: subproject
Signature · 1 line
2.17.1
PATCH v2 2/2 docs: networking: Convert bridge.txt to rst
In reply to Tobin C. HardingThe kernel documentation is now restructured text. Convert the Ethernet Bridge documentation and include it in the toplevel kernel documentation.
- Fix heading adornments.
- Add license identifier.
---
Documentation/networking/{bridge.txt => bridge.rst} | 6 ++++++
Documentation/networking/index.rst | 1 +
2 files changed, 7 insertions(+)
rename Documentation/networking/{bridge.txt => bridge.rst} (85%)Documentation/networking/bridge.rst renamed from Documentation/networking/bridge.txt +6 -0
@@ -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.
Documentation/networking/index.rst +1 -0
@@ -18,6 +18,7 @@ Contents: failover net_failover alias + bridge .. only:: subproject
Signature · 1 line
2.17.1
David Miller
maintainerFrom: "Tobin C. Harding" <[email protected]>
Date: Wed, 18 Jul 2018 13:27:34 +1000
Quoted 9 lines
Here is my first attempt at working on converting docs in
Documentation/networkingto 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.
...
Quoted 2 lines
v2:
- remove incorrect patch from set (changing 'Indices' indentation)
Series applied, thanks Tobin.