From patchwork Tue Jul 17 04:29:04 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tobin C. Harding" X-Patchwork-Id: 944711 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=tobin.cc Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=tobin.cc header.i=@tobin.cc header.b="f4fJNHJ8"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="EmrYqLw/"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41V6kL6qKcz9s4c for ; Tue, 17 Jul 2018 14:29:30 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728349AbeGQE77 (ORCPT ); Tue, 17 Jul 2018 00:59:59 -0400 Received: from wout5-smtp.messagingengine.com ([64.147.123.21]:56633 "EHLO wout5-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726753AbeGQE76 (ORCPT ); Tue, 17 Jul 2018 00:59:58 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id B96CF373; Tue, 17 Jul 2018 00:29:21 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Tue, 17 Jul 2018 00:29:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tobin.cc; h=cc :date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; bh=LBEukSiOpZIHzJq8N 5lWRH2JIQXUCu9WRyM5pd4kbu0=; b=f4fJNHJ89DuadTiZC1f+MD7i32G6usdlD nAcQD70yPJQmGhU56ApGpu4EnjdWWIWkmlXwkQBAXKTBJAODfQtT94bn8T0dxQdS n2LPcIx1vonQCClTwVBXjstAJiWo2gZWPHNngeHhnEJPdidBLIIzAI+ITX7jGAuw TvtzeYNxyeS+oe3Kl4jJJxEk3Xta67bRVCI4F1nae8px5X6k59+Ez23blUFYwnPg xSuDwnGQYIwgz/80mQbq10HR8UGs5HpioQbwR2pM+rfaPjiRWyXEae9XtvhP2084 JBF6/5wG82CTr55BhRH5WYlrKfu5lo7AkHo8cLGJKGSfrT52QLG+A== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm3; bh=LBEukSiOpZIHzJq8N5lWRH2JIQXUCu9WRyM5pd4kbu0=; b=EmrYqLw/ K6SykQwyVDTXJoAP3OTOovmlFm6iIdzsSAHD/0XuJwM6VKVil2QEO5hT063Cq2+b Vd3x4SxhauGTXpWBTgNNRhh4Qa1cuLAv5HpNCRcoutBkgAr4GoQKUQkqf15Jd1Lt gXj8wcnIcjBAUk5/ydLD0bBc93pV9rWXWfwW0yUnqDWL+2EJeGfNTuwdZPRkYix4 RhMfQ1nEQWDYW90cyK4dP1hIADefnaPW9I6GxPl8QQl5CQnr2d7z5tGnKswvKp/A CVFbtu8fqg0S8PB6i5ifcic4/0NyocGp6iDCJ9cRB+8vfZmYmJLDLoJZJCLBLKt7 3wA8NRWT1RJOkA== X-ME-Proxy: X-ME-Sender: Received: from localhost (ppp121-44-239-37.bras2.syd2.internode.on.net [121.44.239.37]) by mail.messagingengine.com (Postfix) with ESMTPA id 8742E10261; Tue, 17 Jul 2018 00:29:20 -0400 (EDT) From: "Tobin C. Harding" To: "David S. Miller" Cc: "Tobin C. Harding" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH net-next 1/3] docs: networking: Fix indices heading indentation Date: Tue, 17 Jul 2018 14:29:04 +1000 Message-Id: <20180717042906.17308-2-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180717042906.17308-1-me@tobin.cc> References: <20180717042906.17308-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Currently the 'Indices' heading is not aligned with column 0, it should be. Fix 'Indices' heading indentation. Signed-off-by: Tobin C. Harding --- 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` From patchwork Tue Jul 17 04:29:05 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tobin C. Harding" X-Patchwork-Id: 944713 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=tobin.cc Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=tobin.cc header.i=@tobin.cc header.b="kOeQoNSm"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="t+yV6wd/"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41V6kW6lsZz9s3Z for ; Tue, 17 Jul 2018 14:29:39 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728883AbeGQFAD (ORCPT ); Tue, 17 Jul 2018 01:00:03 -0400 Received: from wout5-smtp.messagingengine.com ([64.147.123.21]:43809 "EHLO wout5-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726753AbeGQFAD (ORCPT ); Tue, 17 Jul 2018 01:00:03 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id 8AF29207; Tue, 17 Jul 2018 00:29:25 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Tue, 17 Jul 2018 00:29:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tobin.cc; h=cc :date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; bh=E51ZeaKeSCSZRdA9s nfWGr7eofIzogqKM9jkSzBBtWE=; b=kOeQoNSmMxT29wERXH/G4mMUeMDEWQGLf vlP2Ulc2MwaC6i8SrMatuvDFb+B219649uO+hNXucCKPOygcbp92hTXb3QYlBIlV F/yjSBzGuup7gmzEi7fQyvz9nuMaWaRMH5QHk03JHBr+Q6XCKUFxbCurlD9hzpUP 70H6GYJaaHSLxRyu2PIdpHGS0xTDWo5ZCNDe1KMDJYSbcopIhLJFeUpJ+QwHcJtX b+SOmtpmEmTicz0v6TOIle89TRss2QWQBYzqQkBLMVxZ7WqZGNjPF6rtM/XRgk06 2y7SSEYKlC4QDEcL/zZgP1SuAqEHTTVX+E4uM/KN8EPtutaIEPRnA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm3; bh=E51ZeaKeSCSZRdA9snfWGr7eofIzogqKM9jkSzBBtWE=; b=t+yV6wd/ F2SJzZHBbny6xE/vvwgOqwEmMAj+l+Ok8Q/6lRxRrbgEpwqvQzg6JbuhkS+Mmuxu 0riYH0+rEoYtYwZgmu1L+R3wrWt4QnvN+KyN0gUT1EH7CYBmhWHnqlFBzlmg/nmi KdF8uodBbLQw5u0aHgIoMmbYm/pY2NvojB9NvTd5wzpABDfj3Fo1lC8NUjZ61dRL DyNkYshn0ptEcl2G56I3mMGb7LQEbSk2IjJKY0hcjS+X5Mc80z0aWajkW+0P1+YF 6/J63blY3Q+pYyvkChkcpaKLPnJTJvbXcgaRrZmAXDUkVNgH74ZmKIn+rJBok7Ah CvXv34/drtYtQA== X-ME-Proxy: X-ME-Sender: Received: from localhost (ppp121-44-239-37.bras2.syd2.internode.on.net [121.44.239.37]) by mail.messagingengine.com (Postfix) with ESMTPA id 4E4F410268; Tue, 17 Jul 2018 00:29:24 -0400 (EDT) From: "Tobin C. Harding" To: "David S. Miller" Cc: "Tobin C. Harding" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH net-next 2/3] docs: networking: Convert alias.txt to rst Date: Tue, 17 Jul 2018 14:29:05 +1000 Message-Id: <20180717042906.17308-3-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180717042906.17308-1-me@tobin.cc> References: <20180717042906.17308-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org 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 --- 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 From patchwork Tue Jul 17 04:29:06 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tobin C. Harding" X-Patchwork-Id: 944712 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=tobin.cc Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=tobin.cc header.i=@tobin.cc header.b="ZFA6kw09"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="waQL91VW"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41V6kT6RJyz9s3Z for ; Tue, 17 Jul 2018 14:29:37 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729602AbeGQFAH (ORCPT ); Tue, 17 Jul 2018 01:00:07 -0400 Received: from wout5-smtp.messagingengine.com ([64.147.123.21]:55559 "EHLO wout5-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726753AbeGQFAG (ORCPT ); Tue, 17 Jul 2018 01:00:06 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id 71F70207; Tue, 17 Jul 2018 00:29:29 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Tue, 17 Jul 2018 00:29:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tobin.cc; h=cc :date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; bh=llyu8kt/AANGU+ufu g73RrFNiQyLGZgShGQBqI7yYvw=; b=ZFA6kw09MtcN517GACo8n+KTzyZqIM7y8 mQi13IfYXy0KRv60Ol991fgYQ7BzjZRTagOq2qXuiDmhOh5pn8t1fGeu0dD5XoC8 3PODkvTDPaVrCjRaXzO6x4XSbovLAqTYRkfrL/vvmQXMHeGTKtv1dFzBOhQWmwzY o1MlPuzpM5+gqtEXjoFEuCtwip0VS/3aoDlp00w8YFDYhfxJMXAKWjiF/jy3pvHs Tys4ONdNYdo+gRPdMFzJB/Nx+vTY/vp1Zmt3bg814gJpcPEYRehPVI0dMu6V5SVU ekzN0mwpan5VPcIuD0ZRkA0cmAUzuiZaJRJHwvDW3coqmGCNhXZ3g== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm3; bh=llyu8kt/AANGU+ufug73RrFNiQyLGZgShGQBqI7yYvw=; b=waQL91VW W+pgw0ZhqXgtvtEwHK0Bk/E0ZK+Qxv7CmcE1RarVk6NsBL4ZIfdZ8Sc/RI+nlZIk UzYr1AwSTQ7zEXsjhnSmg9nIR8y3acDBQukTcZwBx+QsBLW0AxymC2QgwzDwCRi/ 0rMrUyySF3N26qSPfeF7y7S4U9twnOgI1a+AcOiMsmSdbavCOqw4ckk8XgkXooxz 6zPyXmMeBwgn1uR/B0MSWFecjYItLbfg/5yEuU052iV8qyr8cX6DcxLVvLIkA7+g WkxDn/TFi0KmoafLtiXrTQhm69LGIN+sAVPLiAqjmGVgTt65jCKEZgSEHWu7G8cv HHElYBBUVVJWsg== X-ME-Proxy: X-ME-Sender: Received: from localhost (ppp121-44-239-37.bras2.syd2.internode.on.net [121.44.239.37]) by mail.messagingengine.com (Postfix) with ESMTPA id 4E0B9E450F; Tue, 17 Jul 2018 00:29:28 -0400 (EDT) From: "Tobin C. Harding" To: "David S. Miller" Cc: "Tobin C. Harding" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH net-next 3/3] docs: networking: Convert bridge.txt to rst Date: Tue, 17 Jul 2018 14:29:06 +1000 Message-Id: <20180717042906.17308-4-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180717042906.17308-1-me@tobin.cc> References: <20180717042906.17308-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org 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 --- 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