From 828092ef77eacc6d8e344be1738dee3070719a45 Mon Sep 17 00:00:00 2001 From: Jeff Kirsher Date: Wed, 10 Oct 2018 12:16:13 -0700 Subject: Documentation: intel: Convert to RST format Now that the documents have been updated to conform to the reStructured Text guidelines, we can now change the file extensions and update the other related references. This converts all of the Intel wired LAN driver documentation to *.rst. Signed-off-by: Jeff Kirsher Tested-by: Andrew Bowers Tested-by: Aaron Brown --- Documentation/networking/00-INDEX | 20 - Documentation/networking/e1000e.rst | 382 +++++++++++++++++ Documentation/networking/e1000e.txt | 382 ----------------- Documentation/networking/i40e.rst | 770 +++++++++++++++++++++++++++++++++++ Documentation/networking/i40e.txt | 770 ----------------------------------- Documentation/networking/iavf.rst | 281 +++++++++++++ Documentation/networking/iavf.txt | 281 ------------- Documentation/networking/ice.rst | 45 ++ Documentation/networking/ice.txt | 45 -- Documentation/networking/igb.rst | 193 +++++++++ Documentation/networking/igb.txt | 193 --------- Documentation/networking/igbvf.rst | 64 +++ Documentation/networking/igbvf.txt | 64 --- Documentation/networking/index.rst | 9 + Documentation/networking/ixgb.rst | 467 +++++++++++++++++++++ Documentation/networking/ixgb.txt | 467 --------------------- Documentation/networking/ixgbe.rst | 527 ++++++++++++++++++++++++ Documentation/networking/ixgbe.txt | 527 ------------------------ Documentation/networking/ixgbevf.rst | 66 +++ Documentation/networking/ixgbevf.txt | 66 --- 20 files changed, 2804 insertions(+), 2815 deletions(-) create mode 100644 Documentation/networking/e1000e.rst delete mode 100644 Documentation/networking/e1000e.txt create mode 100644 Documentation/networking/i40e.rst delete mode 100644 Documentation/networking/i40e.txt create mode 100644 Documentation/networking/iavf.rst delete mode 100644 Documentation/networking/iavf.txt create mode 100644 Documentation/networking/ice.rst delete mode 100644 Documentation/networking/ice.txt create mode 100644 Documentation/networking/igb.rst delete mode 100644 Documentation/networking/igb.txt create mode 100644 Documentation/networking/igbvf.rst delete mode 100644 Documentation/networking/igbvf.txt create mode 100644 Documentation/networking/ixgb.rst delete mode 100644 Documentation/networking/ixgb.txt create mode 100644 Documentation/networking/ixgbe.rst delete mode 100644 Documentation/networking/ixgbe.txt create mode 100644 Documentation/networking/ixgbevf.rst delete mode 100644 Documentation/networking/ixgbevf.txt (limited to 'Documentation/networking') diff --git a/Documentation/networking/00-INDEX b/Documentation/networking/00-INDEX index 2d239770b95f..eb0754475dd0 100644 --- a/Documentation/networking/00-INDEX +++ b/Documentation/networking/00-INDEX @@ -70,12 +70,6 @@ driver.txt - Softnet driver issues. ena.txt - info on Amazon's Elastic Network Adapter (ENA) -e100.txt - - info on Intel's EtherExpress PRO/100 line of 10/100 boards -e1000.txt - - info on Intel's E1000 line of gigabit ethernet boards -e1000e.txt - - README for the Intel Gigabit Ethernet Driver (e1000e). eql.txt - serial IP load balancing fib_trie.txt @@ -94,16 +88,8 @@ generic_netlink.txt - info on Generic Netlink gianfar.txt - Gianfar Ethernet Driver. -i40e.txt - - README for the Intel Ethernet Controller XL710 Driver (i40e). -iavf.txt - - README for the Intel Ethernet Adaptive Virtual Function Driver (iavf). ieee802154.txt - Linux IEEE 802.15.4 implementation, API and drivers -igb.txt - - README for the Intel Gigabit Ethernet Driver (igb). -igbvf.txt - - README for the Intel Gigabit Ethernet Driver (igbvf). ip-sysctl.txt - /proc/sys/net/ipv4/* variables ip_dynaddr.txt @@ -120,12 +106,6 @@ ipvs-sysctl.txt - Per-inode explanation of the /proc/sys/net/ipv4/vs interface. irda.txt - where to get IrDA (infrared) utilities and info for Linux. -ixgb.txt - - README for the Intel 10 Gigabit Ethernet Driver (ixgb). -ixgbe.txt - - README for the Intel 10 Gigabit Ethernet Driver (ixgbe). -ixgbevf.txt - - README for the Intel Virtual Function (VF) Driver (ixgbevf). l2tp.txt - User guide to the L2TP tunnel protocol. lapb-module.txt diff --git a/Documentation/networking/e1000e.rst b/Documentation/networking/e1000e.rst new file mode 100644 index 000000000000..33554e5416c5 --- /dev/null +++ b/Documentation/networking/e1000e.rst @@ -0,0 +1,382 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Linux* Driver for Intel(R) Ethernet Network Connection +====================================================== + +Intel Gigabit Linux driver. +Copyright(c) 2008-2018 Intel Corporation. + +Contents +======== + +- Identifying Your Adapter +- Command Line Parameters +- Additional Configurations +- Support + + +Identifying Your Adapter +======================== +For information on how to identify your adapter, and for the latest Intel +network drivers, refer to the Intel Support website: +https://www.intel.com/support + + +Command Line Parameters +======================= +If the driver is built as a module, the following optional parameters are used +by entering them on the command line with the modprobe command using this +syntax:: + + modprobe e1000e [