Skip to content

Commit

Permalink
net: documentation: build a directory structure for drivers
Browse files Browse the repository at this point in the history
Documentation/networking/ is full of cryptically named files with
driver documentation.  This makes finding interesting information
at a glance really hard.  Move all those files into a directory
called device_drivers (since not all drivers are for device) and
fix up references.

RFC v0.1 -> RFC v1:
 - also add .txt suffix to the files which are missing it (Quentin)

Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Reviewed-by: Quentin Monnet <quentin.monnet@netronome.com>
Acked-by: David Ahern <dsahern@gmail.com>
Acked-by: Henrik Austad <henrik@austad.us>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
Jakub Kicinski authored and David S. Miller committed Dec 5, 2018
1 parent a74f0fa commit b255e50
Show file tree
Hide file tree
Showing 58 changed files with 71 additions and 66 deletions.
2 changes: 1 addition & 1 deletion Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ such as network interfaces, crypto accelerator instances, L2 switches,
etc.

For an overview of the DPAA2 architecture and fsl-mc bus see:
Documentation/networking/dpaa2/overview.rst
Documentation/networking/device_drivers/freescale/dpaa2/overview.rst

As described in the above overview, all DPAA2 objects in a DPRC share the
same hardware "isolation context" and a 10-bit value called an ICID
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Documentation/networking/vortex.txt
Documentation/networking/device_drivers/3com/vortex.txt
Andrew Morton
30 April 2000

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ pool management for network interfaces.
This document provides an overview the Linux DPIO driver, its
subcomponents, and its APIs.

See Documentation/networking/dpaa2/overview.rst for a general overview of DPAA2
and the general DPAA2 driver architecture in Linux.
See Documentation/networking/device_drivers/freescale/dpaa2/overview.rst for
a general overview of DPAA2 and the general DPAA2 driver architecture in Linux.

Driver Overview
---------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ hardware resources, like queues, do not have a corresponding MC object and
are treated as internal resources of other objects.

For a more detailed description of the DPAA2 architecture and its object
abstractions see *Documentation/networking/dpaa2/overview.rst*.
abstractions see *Documentation/networking/device_drivers/freescale/dpaa2/overview.rst*.

Each Linux net device is built on top of a Datapath Network Interface (DPNI)
object and uses Buffer Pools (DPBPs), I/O Portals (DPIOs) and Concentrators
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
48 changes: 24 additions & 24 deletions MAINTAINERS
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Maintainers List (try to look for most precise areas first)
M: Steffen Klassert <klassert@kernel.org>
L: netdev@vger.kernel.org
S: Odd Fixes
F: Documentation/networking/vortex.txt
F: Documentation/networking/device_drivers/3com/vortex.txt
F: drivers/net/ethernet/3com/3c59x.c

3CR990 NETWORK DRIVER
Expand Down Expand Up @@ -740,7 +740,7 @@ R: Saeed Bishara <saeedb@amazon.com>
R: Zorik Machulsky <zorik@amazon.com>
L: netdev@vger.kernel.org
S: Supported
F: Documentation/networking/ena.txt
F: Documentation/networking/device_drivers/amazon/ena.txt
F: drivers/net/ethernet/amazon/

AMD CRYPTOGRAPHIC COPROCESSOR (CCP) DRIVER
Expand Down Expand Up @@ -4187,7 +4187,7 @@ F: net/ax25/sysctl_net_ax25.c
DAVICOM FAST ETHERNET (DMFE) NETWORK DRIVER
L: netdev@vger.kernel.org
S: Orphan
F: Documentation/networking/dmfe.txt
F: Documentation/networking/device_drivers/dec/dmfe.txt
F: drivers/net/ethernet/dec/tulip/dmfe.c

DC390/AM53C974 SCSI driver
Expand Down Expand Up @@ -6899,7 +6899,7 @@ M: Haiyang Zhang <haiyangz@microsoft.com>
M: Stephen Hemminger <sthemmin@microsoft.com>
L: devel@linuxdriverproject.org
S: Maintained
F: Documentation/networking/netvsc.txt
F: Documentation/networking/device_drivers/microsoft/netvsc.txt
F: arch/x86/include/asm/mshyperv.h
F: arch/x86/include/asm/trace/hyperv.h
F: arch/x86/include/asm/hyperv-tlfs.h
Expand Down Expand Up @@ -7483,18 +7483,18 @@ Q: http://patchwork.ozlabs.org/project/intel-wired-lan/list/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/net-queue.git
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.rst
F: Documentation/networking/fm10k.rst
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: Documentation/networking/device_drivers/intel/e100.rst
F: Documentation/networking/device_drivers/intel/e1000.rst
F: Documentation/networking/device_drivers/intel/e1000e.rst
F: Documentation/networking/device_drivers/intel/fm10k.rst
F: Documentation/networking/device_drivers/intel/igb.rst
F: Documentation/networking/device_drivers/intel/igbvf.rst
F: Documentation/networking/device_drivers/intel/ixgb.rst
F: Documentation/networking/device_drivers/intel/ixgbe.rst
F: Documentation/networking/device_drivers/intel/ixgbevf.rst
F: Documentation/networking/device_drivers/intel/i40e.rst
F: Documentation/networking/device_drivers/intel/iavf.rst
F: Documentation/networking/device_drivers/intel/ice.rst
F: drivers/net/ethernet/intel/
F: drivers/net/ethernet/intel/*/
F: include/linux/avf/virtchnl.h
Expand Down Expand Up @@ -7668,8 +7668,8 @@ INTEL PRO/WIRELESS 2100, 2200BG, 2915ABG NETWORK CONNECTION SUPPORT
M: Stanislav Yakovlev <stas.yakovlev@gmail.com>
L: linux-wireless@vger.kernel.org
S: Maintained
F: Documentation/networking/README.ipw2100
F: Documentation/networking/README.ipw2200
F: Documentation/networking/device_drivers/intel/ipw2100.txt
F: Documentation/networking/device_drivers/intel/ipw2200.txt
F: drivers/net/wireless/intel/ipw2x00/

INTEL PSTATE DRIVER
Expand Down Expand Up @@ -10315,8 +10315,8 @@ NETERION 10GbE DRIVERS (s2io/vxge)
M: Jon Mason <jdmason@kudzu.us>
L: netdev@vger.kernel.org
S: Supported
F: Documentation/networking/s2io.txt
F: Documentation/networking/vxge.txt
F: Documentation/networking/device_drivers/neterion/s2io.txt
F: Documentation/networking/device_drivers/neterion/vxge.txt
F: drivers/net/ethernet/neterion/

NETFILTER
Expand Down Expand Up @@ -12325,7 +12325,7 @@ QLOGIC QLA3XXX NETWORK DRIVER
M: Dept-GELinuxNICDev@cavium.com
L: netdev@vger.kernel.org
S: Supported
F: Documentation/networking/LICENSE.qla3xxx
F: Documentation/networking/device_drivers/qlogic/LICENSE.qla3xxx
F: drivers/net/ethernet/qlogic/qla3xxx.*

QLOGIC QLA4XXX iSCSI DRIVER
Expand Down Expand Up @@ -12377,7 +12377,7 @@ L: linux-kernel@vger.kernel.org
S: Maintained
F: drivers/bus/fsl-mc/
F: Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt
F: Documentation/networking/dpaa2/overview.rst
F: Documentation/networking/device_drivers/freescale/dpaa2/overview.rst

QT1010 MEDIA DRIVER
M: Antti Palosaari <crope@iki.fi>
Expand Down Expand Up @@ -14109,7 +14109,7 @@ SPIDERNET NETWORK DRIVER for CELL
M: Ishizaki Kou <kou.ishizaki@toshiba.co.jp>
L: netdev@vger.kernel.org
S: Supported
F: Documentation/networking/spider_net.txt
F: Documentation/networking/device_drivers/toshiba/spider_net.txt
F: drivers/net/ethernet/toshiba/spider_net*

SPMI SUBSYSTEM
Expand Down Expand Up @@ -15099,7 +15099,7 @@ M: Samuel Chessman <chessman@tux.org>
L: tlan-devel@lists.sourceforge.net (subscribers-only)
W: http://sourceforge.net/projects/tlan/
S: Maintained
F: Documentation/networking/tlan.txt
F: Documentation/networking/device_drivers/ti/tlan.txt
F: drivers/net/ethernet/ti/tlan.*

TM6000 VIDEO4LINUX DRIVER
Expand Down
8 changes: 4 additions & 4 deletions drivers/net/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -397,10 +397,10 @@ config NET_SB1000

At present this driver only compiles as a module, so say M here if
you have this card. The module will be called sb1000. Then read
<file:Documentation/networking/README.sb1000> for information on how
to use this module, as it needs special ppp scripts for establishing
a connection. Further documentation and the necessary scripts can be
found at:
<file:Documentation/networking/device_drivers/sb1000.txt> for
information on how to use this module, as it needs special ppp
scripts for establishing a connection. Further documentation
and the necessary scripts can be found at:

<http://www.jacksonville.net/~fventuri/>
<http://home.adelphia.net/~siglercm/sb1000.html>
Expand Down
4 changes: 2 additions & 2 deletions drivers/net/ethernet/3com/3c59x.c
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,7 @@ static int vortex_probe1(struct device *gendev, void __iomem *ioaddr, int irq,

print_info = (vortex_debug > 1);
if (print_info)
pr_info("See Documentation/networking/vortex.txt\n");
pr_info("See Documentation/networking/device_drivers/3com/vortex.txt\n");

pr_info("%s: 3Com %s %s at %p.\n",
print_name,
Expand Down Expand Up @@ -1956,7 +1956,7 @@ vortex_error(struct net_device *dev, int status)
dev->name, tx_status);
if (tx_status == 0x82) {
pr_err("Probably a duplex mismatch. See "
"Documentation/networking/vortex.txt\n");
"Documentation/networking/device_drivers/3com/vortex.txt\n");
}
dump_tx_ring(dev);
}
Expand Down
5 changes: 3 additions & 2 deletions drivers/net/ethernet/3com/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,9 @@ config VORTEX
"Hurricane" (3c555/3cSOHO) PCI

If you have such a card, say Y here. More specific information is in
<file:Documentation/networking/vortex.txt> and in the comments at
the beginning of <file:drivers/net/ethernet/3com/3c59x.c>.
<file:Documentation/networking/device_drivers/3com/vortex.txt> and
in the comments at the beginning of
<file:drivers/net/ethernet/3com/3c59x.c>.

To compile this support as a module, choose M here.

Expand Down
3 changes: 2 additions & 1 deletion drivers/net/ethernet/chelsio/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ config CHELSIO_T1
---help---
This driver supports Chelsio gigabit and 10-gigabit
Ethernet cards. More information about adapter features and
performance tuning is in <file:Documentation/networking/cxgb.txt>.
performance tuning is in
<file:Documentation/networking/device_drivers/chelsio/cxgb.txt>.

For general information about Chelsio and our products, visit
our website at <http://www.chelsio.com>.
Expand Down
2 changes: 1 addition & 1 deletion drivers/net/ethernet/cirrus/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ config CS89x0
---help---
Support for CS89x0 chipset based Ethernet cards. If you have a
network (Ethernet) card of this type, say Y and read the file
<file:Documentation/networking/cs89x0.txt>.
<file:Documentation/networking/device_drivers/cirrus/cs89x0.txt>.

To compile this driver as a module, choose M here. The module
will be called cs89x0.
Expand Down
4 changes: 2 additions & 2 deletions drivers/net/ethernet/dec/tulip/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ config DE4X5
These include the DE425, DE434, DE435, DE450 and DE500 models. If
you have a network card of this type, say Y. More specific
information is contained in
<file:Documentation/networking/de4x5.txt>.
<file:Documentation/networking/device_drivers/dec/de4x5.txt>.

To compile this driver as a module, choose M here. The module will
be called de4x5.
Expand All @@ -137,7 +137,7 @@ config DM9102
This driver is for DM9102(A)/DM9132/DM9801 compatible PCI cards from
Davicom (<http://www.davicom.com.tw/>). If you have such a network
(Ethernet) card, say Y. Some information is contained in the file
<file:Documentation/networking/dmfe.txt>.
<file:Documentation/networking/device_drivers/dec/dmfe.txt>.

To compile this driver as a module, choose M here. The module will
be called dmfe.
Expand Down
2 changes: 1 addition & 1 deletion drivers/net/ethernet/dlink/dl2k.c
Original file line number Diff line number Diff line change
Expand Up @@ -1881,7 +1881,7 @@ Compile command:
gcc -D__KERNEL__ -DMODULE -I/usr/src/linux/include -Wall -Wstrict-prototypes -O2 -c dl2k.c
Read Documentation/networking/dl2k.txt for details.
Read Documentation/networking/device_drivers/dlink/dl2k.txt for details.
*/

24 changes: 12 additions & 12 deletions drivers/net/ethernet/intel/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ config E100
to identify the adapter.

More specific information on configuring the driver is in
<file:Documentation/networking/e100.rst>.
<file:Documentation/networking/device_drivers/intel/e100.rst>.

To compile this driver as a module, choose M here. The module
will be called e100.
Expand All @@ -49,7 +49,7 @@ config E1000
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/e1000.rst>.
<file:Documentation/networking/device_drivers/intel/e1000.rst>.

To compile this driver as a module, choose M here. The module
will be called e1000.
Expand All @@ -69,7 +69,7 @@ config E1000E
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/e1000e.rst>.
<file:Documentation/networking/device_drivers/intel/e1000e.rst>.

To compile this driver as a module, choose M here. The module
will be called e1000e.
Expand Down Expand Up @@ -97,7 +97,7 @@ config IGB
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/igb.rst>.
<file:Documentation/networking/device_drivers/intel/igb.rst>.

To compile this driver as a module, choose M here. The module
will be called igb.
Expand Down Expand Up @@ -133,7 +133,7 @@ config IGBVF
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/igbvf.rst>.
<file:Documentation/networking/device_drivers/intel/igbvf.rst>.

To compile this driver as a module, choose M here. The module
will be called igbvf.
Expand All @@ -150,7 +150,7 @@ config IXGB
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/ixgb.rst>.
<file:Documentation/networking/device_drivers/intel/ixgb.rst>.

To compile this driver as a module, choose M here. The module
will be called ixgb.
Expand All @@ -168,7 +168,7 @@ config IXGBE
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/ixgbe.rst>.
<file:Documentation/networking/device_drivers/intel/ixgbe.rst>.

To compile this driver as a module, choose M here. The module
will be called ixgbe.
Expand Down Expand Up @@ -220,7 +220,7 @@ config IXGBEVF
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/ixgbevf.rst>.
<file:Documentation/networking/device_drivers/intel/ixgbevf.rst>.

To compile this driver as a module, choose M here. The module
will be called ixgbevf. MSI-X interrupt support is required
Expand All @@ -247,7 +247,7 @@ config I40E
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/i40e.rst>.
<file:Documentation/networking/device_drivers/intel/i40e.rst>.

To compile this driver as a module, choose M here. The module
will be called i40e.
Expand Down Expand Up @@ -282,7 +282,7 @@ config I40EVF
This driver was formerly named i40evf.

More specific information on configuring the driver is in
<file:Documentation/networking/iavf.rst>.
<file:Documentation/networking/device_drivers/intel/iavf.rst>.

To compile this driver as a module, choose M here. The module
will be called iavf. MSI-X interrupt support is required
Expand All @@ -300,7 +300,7 @@ config ICE
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/ice.rst>.
<file:Documentation/networking/device_drivers/intel/ice.rst>.

To compile this driver as a module, choose M here. The module
will be called ice.
Expand All @@ -318,7 +318,7 @@ config FM10K
<http://support.intel.com>

More specific information on configuring the driver is in
<file:Documentation/networking/fm10k.rst>.
<file:Documentation/networking/device_drivers/intel/fm10k.rst>.

To compile this driver as a module, choose M here. The module
will be called fm10k. MSI-X interrupt support is required
Expand Down
4 changes: 2 additions & 2 deletions drivers/net/ethernet/neterion/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ config S2IO
on its age.

More specific information on configuring the driver is in
<file:Documentation/networking/s2io.txt>.
<file:Documentation/networking/device_drivers/neterion/s2io.txt>.

To compile this driver as a module, choose M here. The module
will be called s2io.
Expand All @@ -41,7 +41,7 @@ config VXGE
labeled as either one, depending on its age.

More specific information on configuring the driver is in
<file:Documentation/networking/vxge.txt>.
<file:Documentation/networking/device_drivers/neterion/vxge.txt>.

To compile this driver as a module, choose M here. The module
will be called vxge.
Expand Down
4 changes: 2 additions & 2 deletions drivers/net/ethernet/smsc/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ config SMC9194
option if you have a DELL laptop with the docking station, or
another SMC9192/9194 based chipset. Say Y if you want it compiled
into the kernel, and read the file
<file:Documentation/networking/smc9.txt>.
<file:Documentation/networking/device_drivers/smsc/smc9.txt>.

To compile this driver as a module, choose M here. The module
will be called smc9194.
Expand All @@ -43,7 +43,7 @@ config SMC91X
This is a driver for SMC's 91x series of Ethernet chipsets,
including the SMC91C94 and the SMC91C111. Say Y if you want it
compiled into the kernel, and read the file
<file:Documentation/networking/smc9.txt>.
<file:Documentation/networking/device_drivers/smsc/smc9.txt>.

This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you want).
Expand Down
Loading

0 comments on commit b255e50

Please sign in to comment.