summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Kirsher <jeffrey.t.kirsher@intel.com>2018-10-10 12:16:13 -0700
committerJeff Kirsher <jeffrey.t.kirsher@intel.com>2018-10-18 12:41:29 -0700
commit828092ef77eacc6d8e344be1738dee3070719a45 (patch)
tree68d0cd84dee3fdc16e5249d0555053e5d751aee9
parentf12a84a9f650283551915e2dc65f282b9f2b8b76 (diff)
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 <jeffrey.t.kirsher@intel.com> Tested-by: Andrew Bowers <andrewx.bowers@intel.com> Tested-by: Aaron Brown <aaron.f.brown@intel.com>
-rw-r--r--Documentation/networking/00-INDEX20
-rw-r--r--Documentation/networking/e1000e.rst (renamed from Documentation/networking/e1000e.txt)0
-rw-r--r--Documentation/networking/i40e.rst (renamed from Documentation/networking/i40e.txt)0
-rw-r--r--Documentation/networking/iavf.rst (renamed from Documentation/networking/iavf.txt)0
-rw-r--r--Documentation/networking/ice.rst (renamed from Documentation/networking/ice.txt)0
-rw-r--r--Documentation/networking/igb.rst (renamed from Documentation/networking/igb.txt)0
-rw-r--r--Documentation/networking/igbvf.rst (renamed from Documentation/networking/igbvf.txt)0
-rw-r--r--Documentation/networking/index.rst9
-rw-r--r--Documentation/networking/ixgb.rst (renamed from Documentation/networking/ixgb.txt)0
-rw-r--r--Documentation/networking/ixgbe.rst (renamed from Documentation/networking/ixgbe.txt)0
-rw-r--r--Documentation/networking/ixgbevf.rst (renamed from Documentation/networking/ixgbevf.txt)0
-rw-r--r--MAINTAINERS18
-rw-r--r--drivers/net/ethernet/intel/Kconfig23
13 files changed, 37 insertions, 33 deletions
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.txt b/Documentation/networking/e1000e.rst
index 33554e5416c5..33554e5416c5 100644
--- a/Documentation/networking/e1000e.txt
+++ b/Documentation/networking/e1000e.rst
diff --git a/Documentation/networking/i40e.txt b/Documentation/networking/i40e.rst
index 0cc16c525d10..0cc16c525d10 100644
--- a/Documentation/networking/i40e.txt
+++ b/Documentation/networking/i40e.rst
diff --git a/Documentation/networking/iavf.txt b/Documentation/networking/iavf.rst
index f8b42b64eb28..f8b42b64eb28 100644
--- a/Documentation/networking/iavf.txt
+++ b/Documentation/networking/iavf.rst
diff --git a/Documentation/networking/ice.txt b/Documentation/networking/ice.rst
index 1e4948c9e989..1e4948c9e989 100644
--- a/Documentation/networking/ice.txt
+++ b/Documentation/networking/ice.rst
diff --git a/Documentation/networking/igb.txt b/Documentation/networking/igb.rst
index ba16b86d5593..ba16b86d5593 100644
--- a/Documentation/networking/igb.txt
+++ b/Documentation/networking/igb.rst
diff --git a/Documentation/networking/igbvf.txt b/Documentation/networking/igbvf.rst
index a8a9ffa4f8d3..a8a9ffa4f8d3 100644
--- a/Documentation/networking/igbvf.txt
+++ b/Documentation/networking/igbvf.rst
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 8c8a0d2d39db..bd89dae8d578 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -14,7 +14,16 @@ Contents:
dpaa2/index
e100
e1000
+ e1000e
fm10k
+ igb
+ igbvf
+ ixgb
+ ixgbe
+ ixgbevf
+ i40e
+ iavf
+ ice
kapi
z8530book
msg_zerocopy
diff --git a/Documentation/networking/ixgb.txt b/Documentation/networking/ixgb.rst
index 8bd80e27843d..8bd80e27843d 100644
--- a/Documentation/networking/ixgb.txt
+++ b/Documentation/networking/ixgb.rst
diff --git a/Documentation/networking/ixgbe.txt b/Documentation/networking/ixgbe.rst
index 725fc697fd8f..725fc697fd8f 100644
--- a/Documentation/networking/ixgbe.txt
+++ b/Documentation/networking/ixgbe.rst
diff --git a/Documentation/networking/ixgbevf.txt b/Documentation/networking/ixgbevf.rst
index 56cde6366c2f..56cde6366c2f 100644
--- a/Documentation/networking/ixgbevf.txt
+++ b/Documentation/networking/ixgbevf.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index f3641f98a893..10de7baeb902 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7351,16 +7351,16 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue.git
S: Supported
F: Documentation/networking/e100.rst
F: Documentation/networking/e1000.rst
-F: Documentation/networking/e1000e.txt
+F: Documentation/networking/e1000e.rst
F: Documentation/networking/fm10k.rst
-F: Documentation/networking/igb.txt
-F: Documentation/networking/igbvf.txt
-F: Documentation/networking/ixgb.txt
-F: Documentation/networking/ixgbe.txt
-F: Documentation/networking/ixgbevf.txt
-F: Documentation/networking/i40e.txt
-F: Documentation/networking/iavf.txt
-F: Documentation/networking/ice.txt
+F: Documentation/networking/igb.rst
+F: Documentation/networking/igbvf.rst
+F: Documentation/networking/ixgb.rst
+F: Documentation/networking/ixgbe.rst
+F: Documentation/networking/ixgbevf.rst
+F: Documentation/networking/i40e.rst
+F: Documentation/networking/iavf.rst
+F: Documentation/networking/ice.rst
F: drivers/net/ethernet/intel/
F: drivers/net/ethernet/intel/*/
F: include/linux/avf/virtchnl.h
diff --git a/drivers/net/ethernet/intel/Kconfig b/drivers/net/ethernet/intel/Kconfig
index 9ff6da335b2a..fd3373d82a9e 100644
--- a/drivers/net/ethernet/intel/Kconfig
+++ b/drivers/net/ethernet/intel/Kconfig
@@ -68,6 +68,9 @@ config E1000E
<http://support.intel.com>
+ More specific information on configuring the driver is in
+ <file:Documentation/networking/e1000e.rst>.
+
To compile this driver as a module, choose M here. The module
will be called e1000e.
@@ -94,7 +97,7 @@ config IGB
<http://support.intel.com>
More specific information on configuring the driver is in
- <file:Documentation/networking/e1000.rst>.
+ <file:Documentation/networking/igb.rst>.
To compile this driver as a module, choose M here. The module
will be called igb.
@@ -130,7 +133,7 @@ config IGBVF
<http://support.intel.com>
More specific information on configuring the driver is in
- <file:Documentation/networking/e1000.rst>.
+ <file:Documentation/networking/igbvf.rst>.
To compile this driver as a module, choose M here. The module
will be called igbvf.
@@ -147,7 +150,7 @@ config IXGB
<http://support.intel.com>
More specific information on configuring the driver is in
- <file:Documentation/networking/ixgb.txt>.
+ <file:Documentation/networking/ixgb.rst>.
To compile this driver as a module, choose M here. The module
will be called ixgb.
@@ -164,6 +167,9 @@ config IXGBE
<http://support.intel.com>
+ More specific information on configuring the driver is in
+ <file:Documentation/networking/ixgbe.rst>.
+
To compile this driver as a module, choose M here. The module
will be called ixgbe.
@@ -205,7 +211,7 @@ config IXGBEVF
<http://support.intel.com>
More specific information on configuring the driver is in
- <file:Documentation/networking/ixgbevf.txt>.
+ <file:Documentation/networking/ixgbevf.rst>.
To compile this driver as a module, choose M here. The module
will be called ixgbevf. MSI-X interrupt support is required
@@ -222,6 +228,9 @@ config I40E
<http://support.intel.com>
+ More specific information on configuring the driver is in
+ <file:Documentation/networking/i40e.rst>.
+
To compile this driver as a module, choose M here. The module
will be called i40e.
@@ -254,6 +263,9 @@ config I40EVF
This driver was formerly named i40evf.
+ More specific information on configuring the driver is in
+ <file:Documentation/networking/iavf.rst>.
+
To compile this driver as a module, choose M here. The module
will be called iavf. MSI-X interrupt support is required
for this driver to work correctly.
@@ -269,6 +281,9 @@ config ICE
<http://support.intel.com>
+ More specific information on configuring the driver is in
+ <file:Documentation/networking/ice.rst>.
+
To compile this driver as a module, choose M here. The module
will be called ice.