From patchwork Fri Jun 22 00:37: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: 933018 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="DcoR7N1B"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="oa/b10oq"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41BfnR0wK3z9s4b for ; Fri, 22 Jun 2018 10:38:35 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934095AbeFVAh2 (ORCPT ); Thu, 21 Jun 2018 20:37:28 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:33293 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933452AbeFVAhZ (ORCPT ); Thu, 21 Jun 2018 20:37:25 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id A219721C49; Thu, 21 Jun 2018 20:37:24 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Thu, 21 Jun 2018 20:37:24 -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=ljT2nPuahOKWGQfXA NK/6VXUifV3Vqdmpa630xZbqMM=; b=DcoR7N1BM8EJmS4RTKMnTzghOlQ+w+1oO 3R/c8819MSgMcuKBQ3tiM/SMbj7Lni5ObUuuvY6PCSyyvOqg0MJxlB9joREMAeB5 Uwj/3x1Ob/8WksvwZlf7z9tHdJS0ZUkGtlGMSQ39lL0WBn4RS+YYp6jpj2dammNA kFGBVct8AwpJgZ49rJEf0f+WPRD44QQ63PQtbrpzdKNu8SUAov13vqLWhv4EW2xT L8pSJYczt9TSL1ZQ+twlby4yJlRn1CdcIowsQy1j0KypC+FQ2ZU6ivMGky1N6sre 5Huvkq1m0z3TsLr0K4NU+kZ7U37gSqHici2V7Rr1Y+xwOTulMmt9Q== 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=ljT2nPuahOKWGQfXANK/6VXUifV3Vqdmpa630xZbqMM=; b=oa/b10oq RlTRA2bqroyJODc6te6N3ULH84e6TNHoJOgNxIx7HWZ5vaVa0OHH11gP8driwbE6 kQ5Or/4MElatkQRL9BERiUwEEQwX0OBLlYiwqsFglx4o9qX2bT5IpL/yLSMOl/SG mDGRFOKJpCSqK1u4z+vOQ4wjzD30h7ADw1OM08GyksrNCfXYW/mumQjVesx84Be6 O0SjlOuGYtuzAy6raECIfLCtsm8fKZ/iXelxJr4M52hXzoXzHrQXunvCyGeuWJCh 7u5zexa55WddCm7c2pB85JoplDGZdgjq6HrIo0a9ptlvlsEHiV0NV1dieuIYmMcK p8BFoQZj2s+keQ== X-ME-Proxy: X-ME-Sender: Received: from localhost (124-169-15-204.dyn.iinet.net.au [124.169.15.204]) by mail.messagingengine.com (Postfix) with ESMTPA id D3373E4448; Thu, 21 Jun 2018 20:37:23 -0400 (EDT) From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Jeff Kirsher , "David S. Miller" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 1/4] Documentation: e100: Use correct heading adornment Date: Fri, 22 Jun 2018 10:37:05 +1000 Message-Id: <20180622003708.31848-2-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180622003708.31848-1-me@tobin.cc> References: <20180622003708.31848-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Recently documentation file was converted to rst. The document title has the incorrect heading adornment. From kernel docs: * Please stick to this order of heading adornments: 1. ``=`` with overline for document title:: ============== Document title ============== Add overline heading adornment to document title. Fixes commit (85d63445f411 Documentation: e100: Update the Intel 10/100 driver doc) CC: Jeff Kirsher Signed-off-by: Tobin C. Harding Acked-by: Jeff Kirsher --- Documentation/networking/e100.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/networking/e100.rst b/Documentation/networking/e100.rst index d4d837027925..59b80608e27d 100644 --- a/Documentation/networking/e100.rst +++ b/Documentation/networking/e100.rst @@ -1,3 +1,4 @@ +============================================================== Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters ============================================================== From patchwork Fri Jun 22 00:37: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: 933017 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="XdyGDCZ6"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="RvqkGld4"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41BfnC3BCVz9s47 for ; Fri, 22 Jun 2018 10:38:23 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934205AbeFVAiM (ORCPT ); Thu, 21 Jun 2018 20:38:12 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:51209 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934094AbeFVAh2 (ORCPT ); Thu, 21 Jun 2018 20:37:28 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 2122521BD2; Thu, 21 Jun 2018 20:37:28 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Thu, 21 Jun 2018 20:37:28 -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=ZWpDjBEvXW0OcJ/6F Dm9PNrXTE/3OSO9/YP/tmlUtDg=; b=XdyGDCZ6QsWlnqjHpyFYEOr82oY7qO2CJ /kwG9cAqPdizd7Mnsl4buYcfC73XfwuYuX0QGfW6X51C4aEf60sT5skJ39auhazu +XytnKGJTXlm9WIsj3l/X+21UbddkYeyEyhsn8VQo8qRLhRN6G1DBSZn9/I30Fa5 6hOzSv0eV9TSqX8971aEFAYGKrU5e8AFTeK8R5d1Oqzm7gC0/oCWMYdo+yyKrOWO rzuyERhJfvFdnWx+WibhuAMNXwH/XH+tGqtOPWPeufEkLGxcwugTjEQEtZXpUf02 kuxCmZn3wgAJA/1ov6cWGqWTMlTq6tIHheuAc02GfqLN99T8AdCDg== 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=ZWpDjBEvXW0OcJ/6FDm9PNrXTE/3OSO9/YP/tmlUtDg=; b=RvqkGld4 x78lfj1cNjwPS3QVODV75uH3aLWPw0Hcn8cE5D04thD8ADqtoGJ9WLRLyv1do0LA Ffk1icLoiQvB5BxbopTpVvy1wI4JQhY7pUZwdJAXk4JMpb/Mk0/LKh2+YTjlD91a MCZ9lMhGIp6KPgfnR7aXYKymZCmR6AIz6FjloLUqLCxzhobnH577OicwuA2zq6j2 sKuzMQk2zSMVwvRKxAv4yAVZrnjXBVQ84kjavZ6E3Q8v3FkKSpZ4EO2SdqOk7rVM P2dUN2jzSOAzZsSfg8IjY/31V0Dbaiav+Fsr6r8g9HWIit4rBEGA5j3F3WK/WpeP tIDHbsNmY+/RdA== X-ME-Proxy: X-ME-Sender: Received: from localhost (124-169-15-204.dyn.iinet.net.au [124.169.15.204]) by mail.messagingengine.com (Postfix) with ESMTPA id 56E3910255; Thu, 21 Jun 2018 20:37:27 -0400 (EDT) From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Jeff Kirsher , "David S. Miller" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/4] Documentation: e1000: Use correct heading adornment Date: Fri, 22 Jun 2018 10:37:06 +1000 Message-Id: <20180622003708.31848-3-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180622003708.31848-1-me@tobin.cc> References: <20180622003708.31848-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Recently documentation file was converted to rst. The document title has the incorrect heading adornment. From kernel docs: * Please stick to this order of heading adornments: 1. ``=`` with overline for document title:: ============== Document title ============== Add overline heading adornment to document title. Fixes commit (228046e76189 Documentation: e1000: Update kernel documentation) CC: Jeff Kirsher Signed-off-by: Tobin C. Harding Acked-by: Jeff Kirsher --- Documentation/networking/e1000.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst index 616848940e63..55f28e5043b6 100644 --- a/Documentation/networking/e1000.rst +++ b/Documentation/networking/e1000.rst @@ -1,3 +1,4 @@ +=========================================================== Linux* Base Driver for Intel(R) Ethernet Network Connection =========================================================== From patchwork Fri Jun 22 00:37:07 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: 933016 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="auK9XTCV"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="RnNwX3gI"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41Bfmq4gWXz9s47 for ; Fri, 22 Jun 2018 10:38:03 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934128AbeFVAhg (ORCPT ); Thu, 21 Jun 2018 20:37:36 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:48099 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933452AbeFVAhc (ORCPT ); Thu, 21 Jun 2018 20:37:32 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id B6D8B21D37; Thu, 21 Jun 2018 20:37:31 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Thu, 21 Jun 2018 20:37:31 -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=6rpt39HG8d4J4p6Eh f5PRQ9qfrd56/XFTdB7cYupSh4=; b=auK9XTCVWfQvDAokvHiKLi4bdlIyiKzG6 dFLYUdrUX2SOrOi4nsDicnWRmg0V26Y57GRz2T7AJX0pUvZeig/8ykGnMbqI3l0F htqvkF/CS+M3wfLeTOl3bkLlQHFy4uezzQl1fGkKVT+wJVlSqwqPuOKKfwdOQi4G QY3bMBoIIuoP6NA6S/oOr4VEca2Kxa4TUtUB2+/I1No/n3CoW1mrRqmvtF9e+0uL quUuBNfQJkf8fdN72/iG/LcsNF33piQwpGbl6nFOof/SdbACQd5xFDfMqX+hvGQE OhQlRVUrst2Gx4wPfBtlQpQC3ZO2Bh5aGyOoSkIPXdYXn791Ugoiw== 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=6rpt39HG8d4J4p6Ehf5PRQ9qfrd56/XFTdB7cYupSh4=; b=RnNwX3gI rmROp038kU1cazZIeZDtt1U9BR5aSVk7GGnIBdP22NHBIDPjxSUl+kAId9sVOi3U TbQ+n6C6bP3TMjKTlYKSRipke61utLZpU9JCjsHJaacRL7uBcKHSKmUfBAFpT58f prGPft06k51UJPnwf6hPmozq5SO4segQBdpD6IEKi4EE4NzjmbuOpX3LsZRL3otl w2S4+z5bw6s/DNGzKb7tnm/IdV5aYuTSUS8s3IqKU8idFwCn6I0VAZO0u5PF3Y6o erUt6nvrXzRnbZUIKxF/Ieg3vJiM+n+JXVSLoIQu6Ld4EZrhj6l2im/jpxh/Wzew 8DsVcfVaL+S1Qw== X-ME-Proxy: X-ME-Sender: Received: from localhost (124-169-15-204.dyn.iinet.net.au [124.169.15.204]) by mail.messagingengine.com (Postfix) with ESMTPA id EE1CEE4448; Thu, 21 Jun 2018 20:37:30 -0400 (EDT) From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Jeff Kirsher , "David S. Miller" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 3/4] Documentation: e100: Fix docs build error Date: Fri, 22 Jun 2018 10:37:07 +1000 Message-Id: <20180622003708.31848-4-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180622003708.31848-1-me@tobin.cc> References: <20180622003708.31848-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Recent patch updated e100 docs to rst format. Docs build (`make htmldocs`) is currently failing due to this file with error: (SEVERE/4) Unexpected section title. This is because a section of the file is indented 2 spaces. Build error can be cleared by aligning the text with column 0. While we are changing these lines we can make sure line length does not exceed 72, that newlines following headings are uniform, and that full stops are followed by two spaces. Align text with column 0, limit line length to 72, ensure two spaces follow all full stops, ensure uniform use of newlines after heading. Fixes commit (85d63445f411 Documentation: e100: Update the Intel 10/100 driver doc) CC: Jeff Kirsher Signed-off-by: Tobin C. Harding Acked-by: Jeff Kirsher --- Documentation/networking/e100.rst | 115 +++++++++++++++--------------- 1 file changed, 58 insertions(+), 57 deletions(-) diff --git a/Documentation/networking/e100.rst b/Documentation/networking/e100.rst index 59b80608e27d..9708f5fa76de 100644 --- a/Documentation/networking/e100.rst +++ b/Documentation/networking/e100.rst @@ -87,83 +87,84 @@ Event Log Message Level: The driver uses the message level flag to log events Additional Configurations ========================= - Configuring the Driver on Different Distributions - ------------------------------------------------- - - Configuring a network driver to load properly when the system is started is - distribution dependent. Typically, the configuration process involves adding - an alias line to /etc/modprobe.d/*.conf as well as editing other system - startup scripts and/or configuration files. Many popular Linux - distributions ship with tools to make these changes for you. To learn the - proper way to configure a network device for your system, refer to your - distribution documentation. If during this process you are asked for the - driver or module name, the name for the Linux Base Driver for the Intel - PRO/100 Family of Adapters is e100. - - As an example, if you install the e100 driver for two PRO/100 adapters - (eth0 and eth1), add the following to a configuration file in /etc/modprobe.d/ +Configuring the Driver on Different Distributions +------------------------------------------------- + +Configuring a network driver to load properly when the system is started +is distribution dependent. Typically, the configuration process involves +adding an alias line to /etc/modprobe.d/*.conf as well as editing other +system startup scripts and/or configuration files. Many popular Linux +distributions ship with tools to make these changes for you. To learn +the proper way to configure a network device for your system, refer to +your distribution documentation. If during this process you are asked +for the driver or module name, the name for the Linux Base Driver for +the Intel PRO/100 Family of Adapters is e100. + +As an example, if you install the e100 driver for two PRO/100 adapters +(eth0 and eth1), add the following to a configuration file in +/etc/modprobe.d/:: alias eth0 e100 alias eth1 e100 - Viewing Link Messages - --------------------- - In order to see link messages and other Intel driver information on your - console, you must set the dmesg level up to six. This can be done by - entering the following on the command line before loading the e100 driver:: +Viewing Link Messages +--------------------- - dmesg -n 6 - - If you wish to see all messages issued by the driver, including debug - messages, set the dmesg level to eight. +In order to see link messages and other Intel driver information on your +console, you must set the dmesg level up to six. This can be done by +entering the following on the command line before loading the e100 +driver:: - NOTE: This setting is not saved across reboots. + dmesg -n 6 +If you wish to see all messages issued by the driver, including debug +messages, set the dmesg level to eight. - ethtool - ------- +NOTE: This setting is not saved across reboots. - The driver utilizes the ethtool interface for driver configuration and - diagnostics, as well as displaying statistical information. The ethtool - version 1.6 or later is required for this functionality. +ethtool +------- - The latest release of ethtool can be found from - https://www.kernel.org/pub/software/network/ethtool/ +The driver utilizes the ethtool interface for driver configuration and +diagnostics, as well as displaying statistical information. The ethtool +version 1.6 or later is required for this functionality. - Enabling Wake on LAN* (WoL) - --------------------------- - WoL is provided through the ethtool* utility. For instructions on enabling - WoL with ethtool, refer to the ethtool man page. +The latest release of ethtool can be found from +https://www.kernel.org/pub/software/network/ethtool/ - WoL will be enabled on the system during the next shut down or reboot. For - this driver version, in order to enable WoL, the e100 driver must be - loaded when shutting down or rebooting the system. +Enabling Wake on LAN* (WoL) +--------------------------- +WoL is provided through the ethtool* utility. For instructions on +enabling WoL with ethtool, refer to the ethtool man page. WoL will be +enabled on the system during the next shut down or reboot. For this +driver version, in order to enable WoL, the e100 driver must be loaded +when shutting down or rebooting the system. - NAPI - ---- +NAPI +---- - NAPI (Rx polling mode) is supported in the e100 driver. +NAPI (Rx polling mode) is supported in the e100 driver. - See https://wiki.linuxfoundation.org/networking/napi for more information - on NAPI. +See https://wiki.linuxfoundation.org/networking/napi for more +information on NAPI. - Multiple Interfaces on Same Ethernet Broadcast Network - ------------------------------------------------------ +Multiple Interfaces on Same Ethernet Broadcast Network +------------------------------------------------------ - Due to the default ARP behavior on Linux, it is not possible to have - one system on two IP networks in the same Ethernet broadcast domain - (non-partitioned switch) behave as expected. All Ethernet interfaces - will respond to IP traffic for any IP address assigned to the system. - This results in unbalanced receive traffic. +Due to the default ARP behavior on Linux, it is not possible to have one +system on two IP networks in the same Ethernet broadcast domain +(non-partitioned switch) behave as expected. All Ethernet interfaces +will respond to IP traffic for any IP address assigned to the system. +This results in unbalanced receive traffic. - If you have multiple interfaces in a server, either turn on ARP - filtering by +If you have multiple interfaces in a server, either turn on ARP +filtering by - (1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter - (this only works if your kernel's version is higher than 2.4.5), or +(1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter + (this only works if your kernel's version is higher than 2.4.5), or - (2) installing the interfaces in separate broadcast domains (either - in different switches or in a switch partitioned to VLANs). +(2) installing the interfaces in separate broadcast domains (either + in different switches or in a switch partitioned to VLANs). Support From patchwork Fri Jun 22 00:37:08 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: 933015 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="nzAltdf2"; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.b="C3t3VFNW"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 41Bfmc6Yk1z9s47 for ; Fri, 22 Jun 2018 10:37:52 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934175AbeFVAhj (ORCPT ); Thu, 21 Jun 2018 20:37:39 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:53019 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934129AbeFVAhg (ORCPT ); Thu, 21 Jun 2018 20:37:36 -0400 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 7C67F21BD2; Thu, 21 Jun 2018 20:37:35 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Thu, 21 Jun 2018 20:37:35 -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=CteCNjkOVcorqDAqT 0ZcOmqYj3/Q4P2LuREvzUnX0yc=; b=nzAltdf2J/oVYZqqNZUDJSQIvGsOUYq3x 6NxhikjfFVZSz4jkUygTSFkGXOWrn7ozGwRJqmlwN5Yr3azKLO/4WHkqBojDFXHi KQGnnLxMdgyncvThFtYBipaDifDxLvsDpt5EeCqor6LiUIhKlaGGn/JQFVoAEkSR BSG1B9lOouphcySYi58RgtkW2NkapzDXo/y6UHNARMCpKw+I7593kK8fbhH/iLAE QoJNLSETWKgwuT2uJVT2yX//US4Ny5acT7ku65ddiCMLOk1GMPglT++yXQb4dnxL xplbhmEcunqjOnuJbNHLZQM1DKE2tU3BIRqkzvfrcdLhcFjX+9grA== 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=CteCNjkOVcorqDAqT0ZcOmqYj3/Q4P2LuREvzUnX0yc=; b=C3t3VFNW wkNT9jdNHbPLvdLHEYbapgaDHMKr6ocjnW0t9xsGM2mrRFQJ5T4ABdlznEWWpADY YUag0jhlEPObSAK0dDXoIC0uOOCWy+t3Un2cIt2uhwglSjr0HWlg6Fqw+1nOy0a9 9Htap7qpxrrCghQbrLrf3HfSJ7NdecCiGyzgktn1wm0NGBTDhiIOcuZIVpkbVMu6 2IeQdnRsDVSmY5Vde3kR24Y1hJYs6IkzFIqRIxTXkq3AhD95QK/q+4J921wFuvmB Zhewd22JiyiQh6gAg8rigoHnS/oHks7Y5DCFL5mT0OzHaNixvfdCPX6GCNtBMyjO cro3yVF6t/VL5Q== X-ME-Proxy: X-ME-Sender: Received: from localhost (124-169-15-204.dyn.iinet.net.au [124.169.15.204]) by mail.messagingengine.com (Postfix) with ESMTPA id A205DE4115; Thu, 21 Jun 2018 20:37:34 -0400 (EDT) From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Jeff Kirsher , "David S. Miller" , linux-doc@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 4/4] Documentation: e1000: Fix docs build error Date: Fri, 22 Jun 2018 10:37:08 +1000 Message-Id: <20180622003708.31848-5-me@tobin.cc> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180622003708.31848-1-me@tobin.cc> References: <20180622003708.31848-1-me@tobin.cc> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Recent patch updated e1000 docs to rst format. Docs build (`make htmldocs`) is currently failing due to this file with error: (SEVERE/4) Unexpected section title. This is because a section of the file is indented 2 spaces. Build error can be cleared by aligning the text with column 0. While we are changing these lines we can make sure line length does not exceed 72, that newlines following headings are uniform, and that full stops are followed by two spaces. Align text with column 0, limit line length to 72, ensure two spaces follow all full stops, ensure uniform use of newlines after heading. Fixes commit (228046e76189 Documentation: e1000: Update kernel documentation) CC: Jeff Kirsher Signed-off-by: Tobin C. Harding Acked-by: Jeff Kirsher --- Documentation/networking/e1000.rst | 75 +++++++++++++++--------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst index 55f28e5043b6..144b87eef153 100644 --- a/Documentation/networking/e1000.rst +++ b/Documentation/networking/e1000.rst @@ -355,57 +355,58 @@ previously mentioned to force the adapter to the same speed and duplex. Additional Configurations ========================= - Jumbo Frames - ------------ - Jumbo Frames support is enabled by changing the MTU to a value larger than - the default of 1500. Use the ifconfig command to increase the MTU size. - For example:: +Jumbo Frames +------------ +Jumbo Frames support is enabled by changing the MTU to a value larger +than the default of 1500. Use the ifconfig command to increase the MTU +size. For example:: ifconfig eth mtu 9000 up - This setting is not saved across reboots. It can be made permanent if - you add:: +This setting is not saved across reboots. It can be made permanent if +you add:: MTU=9000 - to the file /etc/sysconfig/network-scripts/ifcfg-eth. This example - applies to the Red Hat distributions; other distributions may store this - setting in a different location. +to the file /etc/sysconfig/network-scripts/ifcfg-eth. This example +applies to the Red Hat distributions; other distributions may store this +setting in a different location. - Notes: - Degradation in throughput performance may be observed in some Jumbo frames - environments. If this is observed, increasing the application's socket buffer - size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help. - See the specific application manual and /usr/src/linux*/Documentation/ - networking/ip-sysctl.txt for more details. +Notes: Degradation in throughput performance may be observed in some +Jumbo frames environments. If this is observed, increasing the +application's socket buffer size and/or increasing the +/proc/sys/net/ipv4/tcp_*mem entry values may help. See the specific +application manual and /usr/src/linux*/Documentation/ +networking/ip-sysctl.txt for more details. - - The maximum MTU setting for Jumbo Frames is 16110. This value coincides - with the maximum Jumbo Frames size of 16128. +- The maximum MTU setting for Jumbo Frames is 16110. This value + coincides with the maximum Jumbo Frames size of 16128. - - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in - poor performance or loss of link. +- Using Jumbo frames at 10 or 100 Mbps is not supported and may result + in poor performance or loss of link. - - Adapters based on the Intel(R) 82542 and 82573V/E controller do not - support Jumbo Frames. These correspond to the following product names: - Intel(R) PRO/1000 Gigabit Server Adapter - Intel(R) PRO/1000 PM Network Connection +- Adapters based on the Intel(R) 82542 and 82573V/E controller do not + support Jumbo Frames. These correspond to the following product names: + Intel(R) PRO/1000 Gigabit Server Adapter Intel(R) PRO/1000 PM Network + Connection - ethtool - ------- - The driver utilizes the ethtool interface for driver configuration and - diagnostics, as well as displaying statistical information. The ethtool - version 1.6 or later is required for this functionality. +ethtool +------- +The driver utilizes the ethtool interface for driver configuration and +diagnostics, as well as displaying statistical information. The ethtool +version 1.6 or later is required for this functionality. + +The latest release of ethtool can be found from +https://www.kernel.org/pub/software/network/ethtool/ - The latest release of ethtool can be found from - https://www.kernel.org/pub/software/network/ethtool/ +Enabling Wake on LAN* (WoL) +--------------------------- +WoL is configured through the ethtool* utility. - Enabling Wake on LAN* (WoL) - --------------------------- - WoL is configured through the ethtool* utility. +WoL will be enabled on the system during the next shut down or reboot. +For this driver version, in order to enable WoL, the e1000 driver must be +loaded when shutting down or rebooting the system. - WoL will be enabled on the system during the next shut down or reboot. - For this driver version, in order to enable WoL, the e1000 driver must be - loaded when shutting down or rebooting the system. Support =======