docs: networking: convert netdev-features.txt to ReST

Not much to be done here: - add SPDX header; - adjust titles and chapters, adding proper markups; - add to networking/index.rst.

Mauro Carvalho Chehab committed 6 years ago

Commit ea5baca1 parent d9d6ef24 files · +14 −10Browse files

Unified · Split

4 files

Documentation/networking/checksum-offloads.rst +1 −1
Documentation/networking/index.rst +1 −0
Documentation/networking/netdev-features.rst +11 −8
include/linux/netdev_features.h +1 −1

Documentation/networking/checksum-offloads.rst+1−1

@@ -59,7 +59,7 @@ recomputed for each resulting segment. See the skbuff.h comment (section 'E') · 58 unmodified lines
59	59	for more details.
60	60
61	61	A driver declares its offload capabilities in netdev->hw_features; see
62		−Documentation/networking/netdev-features.txt for more. Note that a device
	62	+Documentation/networking/netdev-features.rst for more. Note that a device
63	63	which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start and
64	64	csum_offset given in the SKB; if it tries to deduce these itself in hardware
65	65	(as some NICs do) the driver should check that the values in the SKB match

Documentation/networking/index.rst+1−0

@@ -81,6 +81,7 @@ Contents: · 80 unmodified lines
81	81	mpls-sysctl
82	82	multiqueue
83	83	netconsole
	84	+ netdev-features
84	85
85	86	.. only:: subproject and html
86	87

Documentation/networking/netdev-features.rstrenamed from Documentation/networking/netdev-features.txt+11−8

@@ -1,3 +1,6 @@
	1	+.. SPDX-License-Identifier: GPL-2.0
	2	+
	3	+=====================================================
1	4	Netdev features mess and how to get out from it alive
2	5	=====================================================
3	6
@@ -6,8 +9,8 @@ Author: · 2 unmodified lines
6	9
7	10
8	11
9		− Part I: Feature sets
10		−======================
	12	+Part I: Feature sets
	13	+====================
11	14
12	15	Long gone are the days when a network card would just take and give packets
13	16	verbatim. Today's devices add multiple features and bugs (read: offloads)
@@ -39,8 +42,8 @@ one used internally by network core: · 25 unmodified lines
39	42
40	43
41	44
42		− Part II: Controlling enabled features
43		−=======================================
	45	+Part II: Controlling enabled features
	46	+=====================================
44	47
45	48	When current feature set (netdev->features) is to be changed, new set
46	49	is calculated and filtered by calling ndo_fix_features callback
@@ -65,8 +68,8 @@ driver except by means of ndo_fix_features callback. · 18 unmodified lines
65	68
66	69
67	70
68		− Part III: Implementation hints
69		−================================
	71	+Part III: Implementation hints
	72	+==============================
70	73
71	74	* ndo_fix_features:
72	75
@@ -94,8 +97,8 @@ Errors returned are not (and cannot be) propagated anywhere except dmesg. · 21 unmodified lines
94	97
95	98
96	99
97		− Part IV: Features
98		−===================
	100	+Part IV: Features
	101	+=================
99	102
100	103	For current list of features, see include/linux/netdev_features.h.
101	104	This section describes semantics of some of them.

include/linux/netdev_features.h+1−1

@@ -89,7 +89,7 @@ enum { · 88 unmodified lines
89	89	* Add your fresh new feature above and remember to update
90	90	* netdev_features_strings[] in net/core/ethtool.c and maybe
91	91	* some feature mask #defines below. Please also describe it
92		− * in Documentation/networking/netdev-features.txt.
	92	+ * in Documentation/networking/netdev-features.rst.
93	93	*/
94	94
95	95	/**/NETDEV_FEATURE_COUNT