Skip to content

Commit 482a436

Browse files
mchehabdavem330
authored andcommitted
docs: networking: convert netdevices.txt to ReST
- add SPDX header; - adjust title markup; - mark lists as such; - adjust identation, whitespaces and blank lines; - add to networking/index.rst. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: David S. Miller <[email protected]>
1 parent ea5baca commit 482a436

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

Documentation/networking/can.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1058,7 +1058,7 @@ drivers you mainly have to deal with:
10581058
- TX: Put the CAN frame from the socket buffer to the CAN controller.
10591059
- RX: Put the CAN frame from the CAN controller to the socket buffer.
10601060

1061-
See e.g. at Documentation/networking/netdevices.txt . The differences
1061+
See e.g. at Documentation/networking/netdevices.rst . The differences
10621062
for writing CAN network device driver are described below:
10631063

10641064

Documentation/networking/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Contents:
8282
multiqueue
8383
netconsole
8484
netdev-features
85+
netdevices
8586

8687
.. only:: subproject and html
8788

Documentation/networking/netdevices.txt renamed to Documentation/networking/netdevices.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
.. SPDX-License-Identifier: GPL-2.0
12
3+
=====================================
24
Network Devices, the Kernel, and You!
5+
=====================================
36

47

58
Introduction
@@ -75,11 +78,12 @@ ndo_start_xmit:
7578
Don't use it for new drivers.
7679

7780
Context: Process with BHs disabled or BH (timer),
78-
will be called with interrupts disabled by netconsole.
81+
will be called with interrupts disabled by netconsole.
7982

80-
Return codes:
81-
o NETDEV_TX_OK everything ok.
82-
o NETDEV_TX_BUSY Cannot transmit packet, try later
83+
Return codes:
84+
85+
* NETDEV_TX_OK everything ok.
86+
* NETDEV_TX_BUSY Cannot transmit packet, try later
8387
Usually a bug, means queue start/stop flow control is broken in
8488
the driver. Note: the driver must NOT put the skb in its DMA ring.
8589

@@ -95,10 +99,13 @@ ndo_set_rx_mode:
9599
struct napi_struct synchronization rules
96100
========================================
97101
napi->poll:
98-
Synchronization: NAPI_STATE_SCHED bit in napi->state. Device
102+
Synchronization:
103+
NAPI_STATE_SCHED bit in napi->state. Device
99104
driver's ndo_stop method will invoke napi_disable() on
100105
all NAPI instances which will do a sleeping poll on the
101106
NAPI_STATE_SCHED napi->state bit, waiting for all pending
102107
NAPI activity to cease.
103-
Context: softirq
104-
will be called with interrupts disabled by netconsole.
108+
109+
Context:
110+
softirq
111+
will be called with interrupts disabled by netconsole.

0 commit comments

Comments
 (0)