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

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

Documentation/networking/checksum-offloads.rst

+1 −1
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ recomputed for each resulting segment. See the skbuff.h comment (section 'E') 
for more details.



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

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

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -81,6 +81,7 @@ Contents: 
   mpls-sysctl

   multiqueue

   netconsole

   netdev-features



.. only::  subproject and html

Documentation/networking/netdev-features.txt→Documentation/networking/netdev-features.rst

+11 −8
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=====================================================

Netdev features mess and how to get out from it alive

=====================================================
@@ -7,7 +10,7 @@ Author: 




Part I: Feature sets

======================

====================



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)
@@ -40,7 +43,7 @@ one used internally by network core: 




Part II: Controlling enabled features

=======================================

=====================================



When current feature set (netdev->features) is to be changed, new set

is calculated and filtered by calling ndo_fix_features callback
@@ -66,7 +69,7 @@ driver except by means of ndo_fix_features callback. 




Part III: Implementation hints

================================

==============================



 * ndo_fix_features:
@@ -95,7 +98,7 @@ Errors returned are not (and cannot be) propagated anywhere except dmesg. 




Part IV: Features

===================

=================



For current list of features, see include/linux/netdev_features.h.

This section describes semantics of some of them.

include/linux/netdev_features.h

+1 −1
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ enum { 
	 * Add your fresh new feature above and remember to update

	 * netdev_features_strings[] in net/core/ethtool.c and maybe

	 * some feature mask #defines below. Please also describe it

	 * in Documentation/networking/netdev-features.txt.

	 * in Documentation/networking/netdev-features.rst.

	 */



	/**/NETDEV_FEATURE_COUNT