Commit ea5bacaa authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller

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.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent d9d6ef25
...@@ -59,7 +59,7 @@ recomputed for each resulting segment. See the skbuff.h comment (section 'E') ...@@ -59,7 +59,7 @@ recomputed for each resulting segment. See the skbuff.h comment (section 'E')
for more details. for more details.
A driver declares its offload capabilities in netdev->hw_features; see A driver declares its offload capabilities in netdev->hw_features; see
Documentation/networking/netdev-features.txt for more. Note that a device Documentation/networking/netdev-features.rst for more. Note that a device
which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start and which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start and
csum_offset given in the SKB; if it tries to deduce these itself in hardware csum_offset given in the SKB; if it tries to deduce these itself in hardware
(as some NICs do) the driver should check that the values in the SKB match (as some NICs do) the driver should check that the values in the SKB match
......
...@@ -81,6 +81,7 @@ Contents: ...@@ -81,6 +81,7 @@ Contents:
mpls-sysctl mpls-sysctl
multiqueue multiqueue
netconsole netconsole
netdev-features
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0
=====================================================
Netdev features mess and how to get out from it alive Netdev features mess and how to get out from it alive
===================================================== =====================================================
...@@ -6,8 +9,8 @@ Author: ...@@ -6,8 +9,8 @@ Author:
Part I: Feature sets Part I: Feature sets
====================== ====================
Long gone are the days when a network card would just take and give packets Long gone are the days when a network card would just take and give packets
verbatim. Today's devices add multiple features and bugs (read: offloads) verbatim. Today's devices add multiple features and bugs (read: offloads)
...@@ -39,8 +42,8 @@ one used internally by network core: ...@@ -39,8 +42,8 @@ one used internally by network core:
Part II: Controlling enabled features Part II: Controlling enabled features
======================================= =====================================
When current feature set (netdev->features) is to be changed, new set When current feature set (netdev->features) is to be changed, new set
is calculated and filtered by calling ndo_fix_features callback is calculated and filtered by calling ndo_fix_features callback
...@@ -65,8 +68,8 @@ driver except by means of ndo_fix_features callback. ...@@ -65,8 +68,8 @@ driver except by means of ndo_fix_features callback.
Part III: Implementation hints Part III: Implementation hints
================================ ==============================
* ndo_fix_features: * ndo_fix_features:
...@@ -94,8 +97,8 @@ Errors returned are not (and cannot be) propagated anywhere except dmesg. ...@@ -94,8 +97,8 @@ Errors returned are not (and cannot be) propagated anywhere except dmesg.
Part IV: Features Part IV: Features
=================== =================
For current list of features, see include/linux/netdev_features.h. For current list of features, see include/linux/netdev_features.h.
This section describes semantics of some of them. This section describes semantics of some of them.
......
...@@ -89,7 +89,7 @@ enum { ...@@ -89,7 +89,7 @@ enum {
* Add your fresh new feature above and remember to update * Add your fresh new feature above and remember to update
* netdev_features_strings[] in net/core/ethtool.c and maybe * netdev_features_strings[] in net/core/ethtool.c and maybe
* some feature mask #defines below. Please also describe it * some feature mask #defines below. Please also describe it
* in Documentation/networking/netdev-features.txt. * in Documentation/networking/netdev-features.rst.
*/ */
/**/NETDEV_FEATURE_COUNT /**/NETDEV_FEATURE_COUNT
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment