History

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
  1. Documentation/networking/checksum-offloads.rst +1 −1
  2. Documentation/networking/index.rst +1 −0
  3. Documentation/networking/netdev-features.rst +11 −8
  4. 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
59for more details.59for more details.
60 60
61A driver declares its offload capabilities in netdev->hw_features; see61A driver declares its offload capabilities in netdev->hw_features; see
62Documentation/networking/netdev-features.txt for more. Note that a device62Documentation/networking/netdev-features.rst for more. Note that a device
63which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start and63which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start and
64csum_offset given in the SKB; if it tries to deduce these itself in hardware64csum_offset given in the SKB; if it tries to deduce these itself in hardware
65(as some NICs do) the driver should check that the values in the SKB match65(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 mpls-sysctl81 mpls-sysctl
82 multiqueue82 multiqueue
83 netconsole83 netconsole
84 netdev-features
84 85
85.. only:: subproject and html86.. 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=====================================================
1Netdev features mess and how to get out from it alive4Netdev 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 sets12Part I: Feature sets
10======================13====================
11 14
12Long gone are the days when a network card would just take and give packets15Long gone are the days when a network card would just take and give packets
13verbatim. Today's devices add multiple features and bugs (read: offloads)16verbatim. 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 features45Part II: Controlling enabled features
43=======================================46=====================================
44 47
45When current feature set (netdev->features) is to be changed, new set48When current feature set (netdev->features) is to be changed, new set
46is calculated and filtered by calling ndo_fix_features callback49is 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 hints71Part III: Implementation hints
69================================72==============================
70 73
71 * ndo_fix_features: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: Features100Part IV: Features
98===================101=================
99 102
100For current list of features, see include/linux/netdev_features.h.103For current list of features, see include/linux/netdev_features.h.
101This section describes semantics of some of them.104This section describes semantics of some of them.
include/linux/netdev_features.h+1−1
@@ -89,7 +89,7 @@ enum { · 88 unmodified lines
89 * Add your fresh new feature above and remember to update89 * Add your fresh new feature above and remember to update
90 * netdev_features_strings[] in net/core/ethtool.c and maybe90 * netdev_features_strings[] in net/core/ethtool.c and maybe
91 * some feature mask #defines below. Please also describe it91 * 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 /**/NETDEV_FEATURE_COUNT95 /**/NETDEV_FEATURE_COUNT