* [PATCH net-next 0/3] docs: Convert alias and bridge to rst
@ 2018-07-17 4:29 Tobin C. Harding
2018-07-17 4:29 ` [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Tobin C. Harding
` (2 more replies)
0 siblings, 3 replies; 7+ messages in thread
From: Tobin C. Harding @ 2018-07-17 4:29 UTC (permalink / raw)
To: David S. Miller; +Cc: Tobin C. Harding, linux-doc, netdev, linux-kernel
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.
Tobin C. Harding (3):
docs: networking: Fix indices heading indentation
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 | 6 ++-
5 files changed, 59 insertions(+), 44 deletions(-)
create mode 100644 Documentation/networking/alias.rst
delete mode 100644 Documentation/networking/alias.txt
rename Documentation/networking/{bridge.txt => bridge.rst} (85%)
--
2.17.1
^ permalink raw reply [flat|nested] 7+ messages in thread* [PATCH net-next 1/3] docs: networking: Fix indices heading indentation 2018-07-17 4:29 [PATCH net-next 0/3] docs: Convert alias and bridge to rst Tobin C. Harding @ 2018-07-17 4:29 ` Tobin C. Harding 2018-07-17 8:28 ` Markus Heiser 2018-07-17 4:29 ` [PATCH net-next 2/3] docs: networking: Convert alias.txt to rst Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 3/3] docs: networking: Convert bridge.txt " Tobin C. Harding 2 siblings, 1 reply; 7+ messages in thread From: Tobin C. Harding @ 2018-07-17 4:29 UTC (permalink / raw) To: David S. Miller; +Cc: Tobin C. Harding, linux-doc, netdev, linux-kernel Currently the 'Indices' heading is not aligned with column 0, it should be. Fix 'Indices' heading indentation. Signed-off-by: Tobin C. Harding <me@tobin.cc> --- Documentation/networking/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index 6123a7e9e1da..a4bbde70bcb9 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -20,7 +20,7 @@ Contents: .. only:: subproject - Indices - ======= +Indices +======= * :ref:`genindex` -- 2.17.1 ^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH net-next 1/3] docs: networking: Fix indices heading indentation 2018-07-17 4:29 ` [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Tobin C. Harding @ 2018-07-17 8:28 ` Markus Heiser 2018-07-17 11:45 ` Markus Heiser 2018-07-18 3:23 ` Tobin C. Harding 0 siblings, 2 replies; 7+ messages in thread From: Markus Heiser @ 2018-07-17 8:28 UTC (permalink / raw) To: Tobin C. Harding, David S. Miller; +Cc: linux-doc, netdev, linux-kernel Am Dienstag, den 17.07.2018, 14:29 +1000 schrieb Tobin C. Harding: > Currently the 'Indices' heading is not aligned with column 0, it should > be. Hi Tobin, thats not correct. The 'Indices' heading is a part of the 'only' block: http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags -- Markus -- > > Fix 'Indices' heading indentation. > > Signed-off-by: Tobin C. Harding <me@tobin.cc> > --- > Documentation/networking/index.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst > index 6123a7e9e1da..a4bbde70bcb9 100644 > --- a/Documentation/networking/index.rst > +++ b/Documentation/networking/index.rst > @@ -20,7 +20,7 @@ Contents: > > .. only:: subproject > > - Indices > - ======= > +Indices > +======= > > * :ref:`genindex` ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH net-next 1/3] docs: networking: Fix indices heading indentation 2018-07-17 8:28 ` Markus Heiser @ 2018-07-17 11:45 ` Markus Heiser 2018-07-18 3:23 ` Tobin C. Harding 1 sibling, 0 replies; 7+ messages in thread From: Markus Heiser @ 2018-07-17 11:45 UTC (permalink / raw) To: Tobin C. Harding, David S. Miller; +Cc: linux-doc, netdev, linux-kernel Am Dienstag, den 17.07.2018, 10:28 +0200 schrieb Markus Heiser: > Am Dienstag, den 17.07.2018, 14:29 +1000 schrieb Tobin C. Harding: > > Currently the 'Indices' heading is not aligned with column 0, it should > > be. > > Hi Tobin, thats not correct. The 'Indices' heading is a part of the 'only' > block: > > http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags > > -- Markus -- I realized that we have not well documented SPHINXDIRS, to be more elaborate .. The tag 'subproject' will be set from the networking/conf.py if you run: make -k SPHINXDIRS="networking" htmldocs to just build only the networking folder (aka subproject). For more info, please run 'make help' and take a look at the 'Documentation targets' section. In short: a subfolder of Documentation/ with a conf.py file in, is a subproject and can be build separate. -- Markus -- > > > > > Fix 'Indices' heading indentation. > > > > Signed-off-by: Tobin C. Harding <me@tobin.cc> > > --- > > Documentation/networking/index.rst | 4 ++-- > > 1 file changed, 2 insertions(+), 2 deletions(-) > > > > diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst > > index 6123a7e9e1da..a4bbde70bcb9 100644 > > --- a/Documentation/networking/index.rst > > +++ b/Documentation/networking/index.rst > > @@ -20,7 +20,7 @@ Contents: > > > > .. only:: subproject > > > > - Indices > > - ======= > > +Indices > > +======= > > > > * :ref:`genindex` > > -- > To unsubscribe from this list: send the line "unsubscribe linux-doc" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH net-next 1/3] docs: networking: Fix indices heading indentation 2018-07-17 8:28 ` Markus Heiser 2018-07-17 11:45 ` Markus Heiser @ 2018-07-18 3:23 ` Tobin C. Harding 1 sibling, 0 replies; 7+ messages in thread From: Tobin C. Harding @ 2018-07-18 3:23 UTC (permalink / raw) To: Markus Heiser; +Cc: David S. Miller, linux-doc, netdev, linux-kernel On Tue, Jul 17, 2018 at 10:28:15AM +0200, Markus Heiser wrote: > Am Dienstag, den 17.07.2018, 14:29 +1000 schrieb Tobin C. Harding: > > Currently the 'Indices' heading is not aligned with column 0, it should > > be. > > Hi Tobin, thats not correct. The 'Indices' heading is a part of the 'only' > block: Thanks for picking this up Markus. A little knowledge is dangerous eh :) Will remove this patch from the set and re-spin. thanks, Tobin. ^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH net-next 2/3] docs: networking: Convert alias.txt to rst 2018-07-17 4:29 [PATCH net-next 0/3] docs: Convert alias and bridge to rst Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Tobin C. Harding @ 2018-07-17 4:29 ` Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 3/3] docs: networking: Convert bridge.txt " Tobin C. Harding 2 siblings, 0 replies; 7+ messages in thread From: Tobin C. Harding @ 2018-07-17 4:29 UTC (permalink / raw) To: David S. Miller; +Cc: Tobin C. Harding, linux-doc, netdev, linux-kernel 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> --- 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 diff --git a/Documentation/networking/00-INDEX b/Documentation/networking/00-INDEX index 2b89d91b376f..1e5153ed8990 100644 --- 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 new file mode 100644 index 000000000000..af7c5ee92014 --- /dev/null +++ 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 deleted file mode 100644 index 85046f53fcfc..000000000000 --- a/Documentation/networking/alias.txt +++ /dev/null @@ -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. diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index a4bbde70bcb9..65502f2031a8 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -17,6 +17,7 @@ Contents: msg_zerocopy failover net_failover + alias .. only:: subproject -- 2.17.1 ^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH net-next 3/3] docs: networking: Convert bridge.txt to rst 2018-07-17 4:29 [PATCH net-next 0/3] docs: Convert alias and bridge to rst Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 2/3] docs: networking: Convert alias.txt to rst Tobin C. Harding @ 2018-07-17 4:29 ` Tobin C. Harding 2 siblings, 0 replies; 7+ messages in thread From: Tobin C. Harding @ 2018-07-17 4:29 UTC (permalink / raw) To: David S. Miller; +Cc: Tobin C. Harding, linux-doc, netdev, linux-kernel The 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. Signed-off-by: Tobin C. Harding <me@tobin.cc> --- 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%) diff --git a/Documentation/networking/bridge.txt b/Documentation/networking/bridge.rst similarity index 85% rename from Documentation/networking/bridge.txt rename to Documentation/networking/bridge.rst index a27cb6214ed7..4aef9cddde2f 100644 --- a/Documentation/networking/bridge.txt +++ b/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 index 65502f2031a8..d75da2ff25c7 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -18,6 +18,7 @@ Contents: failover net_failover alias + bridge .. only:: subproject -- 2.17.1 ^ permalink raw reply related [flat|nested] 7+ messages in thread
end of thread, other threads:[~2018-07-18 3:23 UTC | newest] Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2018-07-17 4:29 [PATCH net-next 0/3] docs: Convert alias and bridge to rst Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Tobin C. Harding 2018-07-17 8:28 ` Markus Heiser 2018-07-17 11:45 ` Markus Heiser 2018-07-18 3:23 ` Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 2/3] docs: networking: Convert alias.txt to rst Tobin C. Harding 2018-07-17 4:29 ` [PATCH net-next 3/3] docs: networking: Convert bridge.txt " Tobin C. Harding
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).