Skip to content

Commit b255e50

Browse files
Jakub Kicinskidavem330
authored andcommitted
net: documentation: build a directory structure for drivers
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>
1 parent a74f0fa commit b255e50

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+71
-66
lines changed

Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ such as network interfaces, crypto accelerator instances, L2 switches,
1010
etc.
1111

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

1515
As described in the above overview, all DPAA2 objects in a DPRC share the
1616
same hardware "isolation context" and a 10-bit value called an ICID

Documentation/networking/vortex.txt renamed to Documentation/networking/device_drivers/3com/vortex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Documentation/networking/vortex.txt
1+
Documentation/networking/device_drivers/3com/vortex.txt
22
Andrew Morton
33
30 April 2000
44

Documentation/networking/dpaa2/dpio-driver.rst renamed to Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst

Lines changed: 2 additions & 2 deletions

Documentation/networking/dpaa2/ethernet-driver.rst renamed to Documentation/networking/device_drivers/freescale/dpaa2/ethernet-driver.rst

Lines changed: 1 addition & 1 deletion

MAINTAINERS

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Maintainers List (try to look for most precise areas first)
140140
M: Steffen Klassert <klassert@kernel.org>
141141
L: netdev@vger.kernel.org
142142
S: Odd Fixes
143-
F: Documentation/networking/vortex.txt
143+
F: Documentation/networking/device_drivers/3com/vortex.txt
144144
F: drivers/net/ethernet/3com/3c59x.c
145145

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

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

41934193
DC390/AM53C974 SCSI driver
@@ -6899,7 +6899,7 @@ M: Haiyang Zhang <haiyangz@microsoft.com>
68996899
M: Stephen Hemminger <sthemmin@microsoft.com>
69006900
L: devel@linuxdriverproject.org
69016901
S: Maintained
6902-
F: Documentation/networking/netvsc.txt
6902+
F: Documentation/networking/device_drivers/microsoft/netvsc.txt
69036903
F: arch/x86/include/asm/mshyperv.h
69046904
F: arch/x86/include/asm/trace/hyperv.h
69056905
F: arch/x86/include/asm/hyperv-tlfs.h
@@ -7483,18 +7483,18 @@ Q: http://patchwork.ozlabs.org/project/intel-wired-lan/list/
74837483
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/net-queue.git
74847484
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue.git
74857485
S: Supported
7486-
F: Documentation/networking/e100.rst
7487-
F: Documentation/networking/e1000.rst
7488-
F: Documentation/networking/e1000e.rst
7489-
F: Documentation/networking/fm10k.rst
7490-
F: Documentation/networking/igb.rst
7491-
F: Documentation/networking/igbvf.rst
7492-
F: Documentation/networking/ixgb.rst
7493-
F: Documentation/networking/ixgbe.rst
7494-
F: Documentation/networking/ixgbevf.rst
7495-
F: Documentation/networking/i40e.rst
7496-
F: Documentation/networking/iavf.rst
7497-
F: Documentation/networking/ice.rst
7486+
F: Documentation/networking/device_drivers/intel/e100.rst
7487+
F: Documentation/networking/device_drivers/intel/e1000.rst
7488+
F: Documentation/networking/device_drivers/intel/e1000e.rst
7489+
F: Documentation/networking/device_drivers/intel/fm10k.rst
7490+
F: Documentation/networking/device_drivers/intel/igb.rst
7491+
F: Documentation/networking/device_drivers/intel/igbvf.rst
7492+
F: Documentation/networking/device_drivers/intel/ixgb.rst
7493+
F: Documentation/networking/device_drivers/intel/ixgbe.rst
7494+
F: Documentation/networking/device_drivers/intel/ixgbevf.rst
7495+
F: Documentation/networking/device_drivers/intel/i40e.rst
7496+
F: Documentation/networking/device_drivers/intel/iavf.rst
7497+
F: Documentation/networking/device_drivers/intel/ice.rst
74987498
F: drivers/net/ethernet/intel/
74997499
F: drivers/net/ethernet/intel/*/
75007500
F: include/linux/avf/virtchnl.h
@@ -7668,8 +7668,8 @@ INTEL PRO/WIRELESS 2100, 2200BG, 2915ABG NETWORK CONNECTION SUPPORT
76687668
M: Stanislav Yakovlev <stas.yakovlev@gmail.com>
76697669
L: linux-wireless@vger.kernel.org
76707670
S: Maintained
7671-
F: Documentation/networking/README.ipw2100
7672-
F: Documentation/networking/README.ipw2200
7671+
F: Documentation/networking/device_drivers/intel/ipw2100.txt
7672+
F: Documentation/networking/device_drivers/intel/ipw2200.txt
76737673
F: drivers/net/wireless/intel/ipw2x00/
76747674

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

1032210322
NETFILTER
@@ -12325,7 +12325,7 @@ QLOGIC QLA3XXX NETWORK DRIVER
1232512325
M: Dept-GELinuxNICDev@cavium.com
1232612326
L: netdev@vger.kernel.org
1232712327
S: Supported
12328-
F: Documentation/networking/LICENSE.qla3xxx
12328+
F: Documentation/networking/device_drivers/qlogic/LICENSE.qla3xxx
1232912329
F: drivers/net/ethernet/qlogic/qla3xxx.*
1233012330

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

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

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

1510515105
TM6000 VIDEO4LINUX DRIVER

drivers/net/Kconfig

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -397,10 +397,10 @@ config NET_SB1000
397397

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

405405
<http://www.jacksonville.net/~fventuri/>
406406
<http://home.adelphia.net/~siglercm/sb1000.html>

drivers/net/ethernet/3com/3c59x.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,7 +1151,7 @@ static int vortex_probe1(struct device *gendev, void __iomem *ioaddr, int irq,
11511151

11521152
print_info = (vortex_debug > 1);
11531153
if (print_info)
1154-
pr_info("See Documentation/networking/vortex.txt\n");
1154+
pr_info("See Documentation/networking/device_drivers/3com/vortex.txt\n");
11551155

11561156
pr_info("%s: 3Com %s %s at %p.\n",
11571157
print_name,
@@ -1956,7 +1956,7 @@ vortex_error(struct net_device *dev, int status)
19561956
dev->name, tx_status);
19571957
if (tx_status == 0x82) {
19581958
pr_err("Probably a duplex mismatch. See "
1959-
"Documentation/networking/vortex.txt\n");
1959+
"Documentation/networking/device_drivers/3com/vortex.txt\n");
19601960
}
19611961
dump_tx_ring(dev);
19621962
}

drivers/net/ethernet/3com/Kconfig

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,9 @@ config VORTEX
7575
"Hurricane" (3c555/3cSOHO) PCI
7676

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

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

drivers/net/ethernet/chelsio/Kconfig

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ config CHELSIO_T1
2424
---help---
2525
This driver supports Chelsio gigabit and 10-gigabit
2626
Ethernet cards. More information about adapter features and
27-
performance tuning is in <file:Documentation/networking/cxgb.txt>.
27+
performance tuning is in
28+
<file:Documentation/networking/device_drivers/chelsio/cxgb.txt>.
2829

2930
For general information about Chelsio and our products, visit
3031
our website at <http://www.chelsio.com>.

drivers/net/ethernet/cirrus/Kconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ config CS89x0
2323
---help---
2424
Support for CS89x0 chipset based Ethernet cards. If you have a
2525
network (Ethernet) card of this type, say Y and read the file
26-
<file:Documentation/networking/cs89x0.txt>.
26+
<file:Documentation/networking/device_drivers/cirrus/cs89x0.txt>.
2727

2828
To compile this driver as a module, choose M here. The module
2929
will be called cs89x0.

drivers/net/ethernet/dec/tulip/Kconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ config DE4X5
113113
These include the DE425, DE434, DE435, DE450 and DE500 models. If
114114
you have a network card of this type, say Y. More specific
115115
information is contained in
116-
<file:Documentation/networking/de4x5.txt>.
116+
<file:Documentation/networking/device_drivers/dec/de4x5.txt>.
117117

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

142142
To compile this driver as a module, choose M here. The module will
143143
be called dmfe.

drivers/net/ethernet/dlink/dl2k.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1881,7 +1881,7 @@ Compile command:
18811881
18821882
gcc -D__KERNEL__ -DMODULE -I/usr/src/linux/include -Wall -Wstrict-prototypes -O2 -c dl2k.c
18831883
1884-
Read Documentation/networking/dl2k.txt for details.
1884+
Read Documentation/networking/device_drivers/dlink/dl2k.txt for details.
18851885
18861886
*/
18871887

drivers/net/ethernet/intel/Kconfig

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ config E100
3333
to identify the adapter.
3434

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

323323
To compile this driver as a module, choose M here. The module
324324
will be called fm10k. MSI-X interrupt support is required

drivers/net/ethernet/neterion/Kconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ config S2IO
2626
on its age.
2727

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

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

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

4646
To compile this driver as a module, choose M here. The module
4747
will be called vxge.

drivers/net/ethernet/smsc/Kconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ config SMC9194
2727
option if you have a DELL laptop with the docking station, or
2828
another SMC9192/9194 based chipset. Say Y if you want it compiled
2929
into the kernel, and read the file
30-
<file:Documentation/networking/smc9.txt>.
30+
<file:Documentation/networking/device_drivers/smsc/smc9.txt>.
3131

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

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

0 commit comments

Comments
 (0)