]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: intel: Convert to RST format
authorJeff Kirsher <jeffrey.t.kirsher@intel.com>
Wed, 10 Oct 2018 19:16:13 +0000 (12:16 -0700)
committerJeff Kirsher <jeffrey.t.kirsher@intel.com>
Thu, 18 Oct 2018 19:41:29 +0000 (12:41 -0700)
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>
13 files changed:
Documentation/networking/00-INDEX
Documentation/networking/e1000e.rst [moved from Documentation/networking/e1000e.txt with 100% similarity]
Documentation/networking/i40e.rst [moved from Documentation/networking/i40e.txt with 100% similarity]
Documentation/networking/iavf.rst [moved from Documentation/networking/iavf.txt with 100% similarity]
Documentation/networking/ice.rst [moved from Documentation/networking/ice.txt with 100% similarity]
Documentation/networking/igb.rst [moved from Documentation/networking/igb.txt with 100% similarity]
Documentation/networking/igbvf.rst [moved from Documentation/networking/igbvf.txt with 100% similarity]
Documentation/networking/index.rst
Documentation/networking/ixgb.rst [moved from Documentation/networking/ixgb.txt with 100% similarity]
Documentation/networking/ixgbe.rst [moved from Documentation/networking/ixgbe.txt with 100% similarity]
Documentation/networking/ixgbevf.rst [moved from Documentation/networking/ixgbevf.txt with 100% similarity]
MAINTAINERS
drivers/net/ethernet/intel/Kconfig

index 2d239770b95f7663217db4b4dc21b743708cf19d..eb0754475dd0c8db631f2e57b6ccf16e07c9f1fb 100644 (file)
@@ -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
index 8c8a0d2d39dbadb7b0bb6ccbd6395cd95c4c5062..bd89dae8d57854a1933ee92411fab430d68d7099 100644 (file)
@@ -14,7 +14,16 @@ Contents:
    dpaa2/index
    e100
    e1000
+   e1000e
    fm10k
+   igb
+   igbvf
+   ixgb
+   ixgbe
+   ixgbevf
+   i40e
+   iavf
+   ice
    kapi
    z8530book
    msg_zerocopy
index f3641f98a8931170ced20ad7a51d17376c4ac3e2..10de7baeb902161f03f77f2143766203a4df4b62 100644 (file)
@@ -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
index 9ff6da335b2ab592c87983614d16ba575f1fe2a0..fd3373d82a9e94c7850631b88c6b4c7c8940f1a1 100644 (file)
@@ -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.