Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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 <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Mauro Carvalho Chehab and committed by
David S. Miller
482a4360 ea5bacaa

+16 -8
+1 -1
Documentation/networking/can.rst
··· 1058 1058 - TX: Put the CAN frame from the socket buffer to the CAN controller. 1059 1059 - RX: Put the CAN frame from the CAN controller to the socket buffer. 1060 1060 1061 - See e.g. at Documentation/networking/netdevices.txt . The differences 1061 + See e.g. at Documentation/networking/netdevices.rst . The differences 1062 1062 for writing CAN network device driver are described below: 1063 1063 1064 1064
+1
Documentation/networking/index.rst
··· 82 82 multiqueue 83 83 netconsole 84 84 netdev-features 85 + netdevices 85 86 86 87 .. only:: subproject and html 87 88
+14 -7
Documentation/networking/netdevices.txt Documentation/networking/netdevices.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 1 2 3 + ===================================== 2 4 Network Devices, the Kernel, and You! 5 + ===================================== 3 6 4 7 5 8 Introduction ··· 78 75 Don't use it for new drivers. 79 76 80 77 Context: Process with BHs disabled or BH (timer), 81 - will be called with interrupts disabled by netconsole. 78 + will be called with interrupts disabled by netconsole. 82 79 83 - Return codes: 84 - o NETDEV_TX_OK everything ok. 85 - o NETDEV_TX_BUSY Cannot transmit packet, try later 80 + Return codes: 81 + 82 + * NETDEV_TX_OK everything ok. 83 + * NETDEV_TX_BUSY Cannot transmit packet, try later 86 84 Usually a bug, means queue start/stop flow control is broken in 87 85 the driver. Note: the driver must NOT put the skb in its DMA ring. 88 86 ··· 99 95 struct napi_struct synchronization rules 100 96 ======================================== 101 97 napi->poll: 102 - Synchronization: NAPI_STATE_SCHED bit in napi->state. Device 98 + Synchronization: 99 + NAPI_STATE_SCHED bit in napi->state. Device 103 100 driver's ndo_stop method will invoke napi_disable() on 104 101 all NAPI instances which will do a sleeping poll on the 105 102 NAPI_STATE_SCHED napi->state bit, waiting for all pending 106 103 NAPI activity to cease. 107 - Context: softirq 108 - will be called with interrupts disabled by netconsole. 104 + 105 + Context: 106 + softirq 107 + will be called with interrupts disabled by netconsole.