* [PATCH 00/37]net: manually convert files to ReST format - part 3 (final)
@ 2020-05-01 14:44 Mauro Carvalho Chehab
2020-05-01 14:44 ` [PATCH 26/37] docs: networking: device drivers: convert microsoft/netvsc.txt to ReST Mauro Carvalho Chehab
2020-05-01 19:33 ` [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) David Miller
0 siblings, 2 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-05-01 14:44 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Samuel Chessman, netdev, Andrew Hendry, Zorik Machulsky,
Sean Tranchetti, Igor Russkikh, Jon Mason, Haiyang Zhang,
linux-x25, Wei Liu, linux-hyperv, Kalle Valo, Jakub Kicinski,
Subash Abhinov Kasiviswanathan, David Ahern, K. Y. Srinivasan,
Ishizaki Kou, Joerg Reuter, Saeed Bishara, Shrijeet Mukherjee,
Netanel Belgazal, Stanislav Yakovlev, Guy Tzalik,
Maxim Krasnyansky, Arthur Kiyanovski, linux-wireless, linux-hams,
linux-parisc, Steffen Klassert, David S. Miller,
Stephen Hemminger
That's the third part (and the final one) of my work to convert the networking
text files into ReST. it is based on linux-next next-20200430 branch.
The full series (including those ones) are at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
The built output documents, on html format is at:
https://www.infradead.org/~mchehab/kernel_docs/networking/
Mauro Carvalho Chehab (37):
docs: networking: convert tuntap.txt to ReST
docs: networking: convert udplite.txt to ReST
docs: networking: convert vrf.txt to ReST
docs: networking: convert vxlan.txt to ReST
docs: networking: convert x25-iface.txt to ReST
docs: networking: convert x25.txt to ReST
docs: networking: convert xfrm_device.txt to ReST
docs: networking: convert xfrm_proc.txt to ReST
docs: networking: convert xfrm_sync.txt to ReST
docs: networking: convert xfrm_sysctl.txt to ReST
docs: networking: convert z8530drv.txt to ReST
docs: networking: device drivers: convert 3com/3c509.txt to ReST
docs: networking: device drivers: convert 3com/vortex.txt to ReST
docs: networking: device drivers: convert amazon/ena.txt to ReST
docs: networking: device drivers: convert aquantia/atlantic.txt to
ReST
docs: networking: device drivers: convert chelsio/cxgb.txt to ReST
docs: networking: device drivers: convert cirrus/cs89x0.txt to ReST
docs: networking: device drivers: convert davicom/dm9000.txt to ReST
docs: networking: device drivers: convert dec/de4x5.txt to ReST
docs: networking: device drivers: convert dec/dmfe.txt to ReST
docs: networking: device drivers: convert dlink/dl2k.txt to ReST
docs: networking: device drivers: convert freescale/dpaa.txt to ReST
docs: networking: device drivers: convert freescale/gianfar.txt to
ReST
docs: networking: device drivers: convert intel/ipw2100.txt to ReST
docs: networking: device drivers: convert intel/ipw2200.txt to ReST
docs: networking: device drivers: convert microsoft/netvsc.txt to ReST
docs: networking: device drivers: convert neterion/s2io.txt to ReST
docs: networking: device drivers: convert neterion/vxge.txt to ReST
docs: networking: device drivers: convert qualcomm/rmnet.txt to ReST
docs: networking: device drivers: convert sb1000.txt to ReST
docs: networking: device drivers: convert smsc/smc9.txt to ReST
docs: networking: device drivers: convert ti/cpsw_switchdev.txt to
ReST
docs: networking: device drivers: convert ti/cpsw.txt to ReST
docs: networking: device drivers: convert ti/tlan.txt to ReST
docs: networking: device drivers: convert toshiba/spider_net.txt to
ReST
net: docs: add page_pool.rst to index.rst
docs: networking: arcnet-hardware.rst: don't duplicate chapter names
Documentation/networking/arcnet-hardware.rst | 8 +-
.../3com/{3c509.txt => 3c509.rst} | 158 +++--
.../3com/{vortex.txt => vortex.rst} | 223 ++++---
.../amazon/{ena.txt => ena.rst} | 142 ++--
.../aquantia/{atlantic.txt => atlantic.rst} | 373 ++++++-----
.../chelsio/{cxgb.txt => cxgb.rst} | 183 ++++--
.../cirrus/{cs89x0.txt => cs89x0.rst} | 557 ++++++++--------
.../davicom/{dm9000.txt => dm9000.rst} | 24 +-
.../dec/{de4x5.txt => de4x5.rst} | 105 +--
.../device_drivers/dec/{dmfe.txt => dmfe.rst} | 35 +-
.../dlink/{dl2k.txt => dl2k.rst} | 228 ++++---
.../freescale/{dpaa.txt => dpaa.rst} | 139 ++--
.../freescale/{gianfar.txt => gianfar.rst} | 21 +-
.../networking/device_drivers/index.rst | 24 +
.../intel/{ipw2100.txt => ipw2100.rst} | 242 ++++---
.../intel/{ipw2200.txt => ipw2200.rst} | 410 +++++++-----
.../microsoft/{netvsc.txt => netvsc.rst} | 57 +-
.../device_drivers/neterion/s2io.rst | 196 ++++++
.../device_drivers/neterion/s2io.txt | 141 ----
.../neterion/{vxge.txt => vxge.rst} | 60 +-
.../qualcomm/{rmnet.txt => rmnet.rst} | 43 +-
.../networking/device_drivers/sb1000.rst | 222 +++++++
.../networking/device_drivers/sb1000.txt | 207 ------
.../networking/device_drivers/smsc/smc9.rst | 49 ++
.../networking/device_drivers/smsc/smc9.txt | 42 --
.../networking/device_drivers/ti/cpsw.rst | 587 +++++++++++++++++
.../networking/device_drivers/ti/cpsw.txt | 541 ----------------
...{cpsw_switchdev.txt => cpsw_switchdev.rst} | 239 ++++---
.../device_drivers/ti/{tlan.txt => tlan.rst} | 73 ++-
.../{spider_net.txt => spider_net.rst} | 58 +-
Documentation/networking/index.rst | 12 +
.../networking/{tuntap.txt => tuntap.rst} | 200 +++---
.../networking/{udplite.txt => udplite.rst} | 175 ++---
Documentation/networking/vrf.rst | 451 +++++++++++++
Documentation/networking/vrf.txt | 418 ------------
.../networking/{vxlan.txt => vxlan.rst} | 33 +-
.../{x25-iface.txt => x25-iface.rst} | 10 +-
Documentation/networking/{x25.txt => x25.rst} | 4 +
.../{xfrm_device.txt => xfrm_device.rst} | 33 +-
.../{xfrm_proc.txt => xfrm_proc.rst} | 31 +
.../{xfrm_sync.txt => xfrm_sync.rst} | 66 +-
.../{xfrm_sysctl.txt => xfrm_sysctl.rst} | 7 +
.../networking/{z8530drv.txt => z8530drv.rst} | 609 +++++++++---------
MAINTAINERS | 30 +-
drivers/net/Kconfig | 4 +-
drivers/net/ethernet/3com/3c59x.c | 4 +-
drivers/net/ethernet/3com/Kconfig | 2 +-
drivers/net/ethernet/chelsio/Kconfig | 2 +-
drivers/net/ethernet/cirrus/Kconfig | 2 +-
drivers/net/ethernet/dec/tulip/Kconfig | 4 +-
drivers/net/ethernet/dlink/dl2k.c | 2 +-
drivers/net/ethernet/neterion/Kconfig | 4 +-
drivers/net/ethernet/smsc/Kconfig | 4 +-
drivers/net/ethernet/ti/Kconfig | 2 +-
drivers/net/ethernet/ti/tlan.c | 2 +-
drivers/net/hamradio/Kconfig | 4 +-
drivers/net/hamradio/scc.c | 2 +-
drivers/net/wireless/intel/ipw2x00/Kconfig | 4 +-
drivers/net/wireless/intel/ipw2x00/ipw2100.c | 2 +-
include/uapi/linux/if_x25.h | 2 +-
net/x25/Kconfig | 4 +-
61 files changed, 4175 insertions(+), 3341 deletions(-)
rename Documentation/networking/device_drivers/3com/{3c509.txt => 3c509.rst} (68%)
rename Documentation/networking/device_drivers/3com/{vortex.txt => vortex.rst} (72%)
rename Documentation/networking/device_drivers/amazon/{ena.txt => ena.rst} (86%)
rename Documentation/networking/device_drivers/aquantia/{atlantic.txt => atlantic.rst} (63%)
rename Documentation/networking/device_drivers/chelsio/{cxgb.txt => cxgb.rst} (81%)
rename Documentation/networking/device_drivers/cirrus/{cs89x0.txt => cs89x0.rst} (61%)
rename Documentation/networking/device_drivers/davicom/{dm9000.txt => dm9000.rst} (92%)
rename Documentation/networking/device_drivers/dec/{de4x5.txt => de4x5.rst} (78%)
rename Documentation/networking/device_drivers/dec/{dmfe.txt => dmfe.rst} (68%)
rename Documentation/networking/device_drivers/dlink/{dl2k.txt => dl2k.rst} (59%)
rename Documentation/networking/device_drivers/freescale/{dpaa.txt => dpaa.rst} (79%)
rename Documentation/networking/device_drivers/freescale/{gianfar.txt => gianfar.rst} (82%)
rename Documentation/networking/device_drivers/intel/{ipw2100.txt => ipw2100.rst} (70%)
rename Documentation/networking/device_drivers/intel/{ipw2200.txt => ipw2200.rst} (64%)
rename Documentation/networking/device_drivers/microsoft/{netvsc.txt => netvsc.rst} (83%)
create mode 100644 Documentation/networking/device_drivers/neterion/s2io.rst
delete mode 100644 Documentation/networking/device_drivers/neterion/s2io.txt
rename Documentation/networking/device_drivers/neterion/{vxge.txt => vxge.rst} (80%)
rename Documentation/networking/device_drivers/qualcomm/{rmnet.txt => rmnet.rst} (73%)
create mode 100644 Documentation/networking/device_drivers/sb1000.rst
delete mode 100644 Documentation/networking/device_drivers/sb1000.txt
create mode 100644 Documentation/networking/device_drivers/smsc/smc9.rst
delete mode 100644 Documentation/networking/device_drivers/smsc/smc9.txt
create mode 100644 Documentation/networking/device_drivers/ti/cpsw.rst
delete mode 100644 Documentation/networking/device_drivers/ti/cpsw.txt
rename Documentation/networking/device_drivers/ti/{cpsw_switchdev.txt => cpsw_switchdev.rst} (51%)
rename Documentation/networking/device_drivers/ti/{tlan.txt => tlan.rst} (73%)
rename Documentation/networking/device_drivers/toshiba/{spider_net.txt => spider_net.rst} (88%)
rename Documentation/networking/{tuntap.txt => tuntap.rst} (58%)
rename Documentation/networking/{udplite.txt => udplite.rst} (65%)
create mode 100644 Documentation/networking/vrf.rst
delete mode 100644 Documentation/networking/vrf.txt
rename Documentation/networking/{vxlan.txt => vxlan.rst} (73%)
rename Documentation/networking/{x25-iface.txt => x25-iface.rst} (96%)
rename Documentation/networking/{x25.txt => x25.rst} (96%)
rename Documentation/networking/{xfrm_device.txt => xfrm_device.rst} (92%)
rename Documentation/networking/{xfrm_proc.txt => xfrm_proc.rst} (95%)
rename Documentation/networking/{xfrm_sync.txt => xfrm_sync.rst} (82%)
rename Documentation/networking/{xfrm_sysctl.txt => xfrm_sysctl.rst} (52%)
rename Documentation/networking/{z8530drv.txt => z8530drv.rst} (57%)
--
2.25.4
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH 26/37] docs: networking: device drivers: convert microsoft/netvsc.txt to ReST
2020-05-01 14:44 [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) Mauro Carvalho Chehab
@ 2020-05-01 14:44 ` Mauro Carvalho Chehab
2020-05-01 19:33 ` [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) David Miller
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-05-01 14:44 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
David S. Miller, Jakub Kicinski, K. Y. Srinivasan, Haiyang Zhang,
Stephen Hemminger, Wei Liu, netdev, linux-hyperv
- add SPDX header;
- adjust titles and chapters, adding proper markups;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../networking/device_drivers/index.rst | 1 +
.../microsoft/{netvsc.txt => netvsc.rst} | 57 +++++++++++--------
MAINTAINERS | 2 +-
3 files changed, 36 insertions(+), 24 deletions(-)
rename Documentation/networking/device_drivers/microsoft/{netvsc.txt => netvsc.rst} (83%)
diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
index f9ce0089ec7d..575f0043b03e 100644
--- a/Documentation/networking/device_drivers/index.rst
+++ b/Documentation/networking/device_drivers/index.rst
@@ -41,6 +41,7 @@ Contents:
freescale/gianfar
intel/ipw2100
intel/ipw2200
+ microsoft/netvsc
.. only:: subproject and html
diff --git a/Documentation/networking/device_drivers/microsoft/netvsc.txt b/Documentation/networking/device_drivers/microsoft/netvsc.rst
similarity index 83%
rename from Documentation/networking/device_drivers/microsoft/netvsc.txt
rename to Documentation/networking/device_drivers/microsoft/netvsc.rst
index cd63556b27a0..c3f51c672a68 100644
--- a/Documentation/networking/device_drivers/microsoft/netvsc.txt
+++ b/Documentation/networking/device_drivers/microsoft/netvsc.rst
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================
Hyper-V network driver
======================
@@ -10,15 +13,15 @@ Windows 10.
Features
========
- Checksum offload
- ----------------
+Checksum offload
+----------------
The netvsc driver supports checksum offload as long as the
Hyper-V host version does. Windows Server 2016 and Azure
support checksum offload for TCP and UDP for both IPv4 and
IPv6. Windows Server 2012 only supports checksum offload for TCP.
- Receive Side Scaling
- --------------------
+Receive Side Scaling
+--------------------
Hyper-V supports receive side scaling. For TCP & UDP, packets can
be distributed among available queues based on IP address and port
number.
@@ -32,30 +35,37 @@ Features
hashing. Using L3 hashing is recommended in this case.
For example, for UDP over IPv4 on eth0:
- To include UDP port numbers in hashing:
- ethtool -N eth0 rx-flow-hash udp4 sdfn
- To exclude UDP port numbers in hashing:
- ethtool -N eth0 rx-flow-hash udp4 sd
- To show UDP hash level:
- ethtool -n eth0 rx-flow-hash udp4
-
- Generic Receive Offload, aka GRO
- --------------------------------
+
+ To include UDP port numbers in hashing::
+
+ ethtool -N eth0 rx-flow-hash udp4 sdfn
+
+ To exclude UDP port numbers in hashing::
+
+ ethtool -N eth0 rx-flow-hash udp4 sd
+
+ To show UDP hash level::
+
+ ethtool -n eth0 rx-flow-hash udp4
+
+Generic Receive Offload, aka GRO
+--------------------------------
The driver supports GRO and it is enabled by default. GRO coalesces
like packets and significantly reduces CPU usage under heavy Rx
load.
- Large Receive Offload (LRO), or Receive Side Coalescing (RSC)
- -------------------------------------------------------------
+Large Receive Offload (LRO), or Receive Side Coalescing (RSC)
+-------------------------------------------------------------
The driver supports LRO/RSC in the vSwitch feature. It reduces the per packet
processing overhead by coalescing multiple TCP segments when possible. The
feature is enabled by default on VMs running on Windows Server 2019 and
- later. It may be changed by ethtool command:
+ later. It may be changed by ethtool command::
+
ethtool -K eth0 lro on
ethtool -K eth0 lro off
- SR-IOV support
- --------------
+SR-IOV support
+--------------
Hyper-V supports SR-IOV as a hardware acceleration option. If SR-IOV
is enabled in both the vSwitch and the guest configuration, then the
Virtual Function (VF) device is passed to the guest as a PCI
@@ -70,8 +80,8 @@ Features
flow direction is desired, these should be applied directly to the
VF slave device.
- Receive Buffer
- --------------
+Receive Buffer
+--------------
Packets are received into a receive area which is created when device
is probed. The receive area is broken into MTU sized chunks and each may
contain one or more packets. The number of receive sections may be changed
@@ -83,8 +93,8 @@ Features
will use slower method to handle very large packets or if the send buffer
area is exhausted.
- XDP support
- -----------
+XDP support
+-----------
XDP (eXpress Data Path) is a feature that runs eBPF bytecode at the early
stage when packets arrive at a NIC card. The goal is to increase performance
for packet processing, reducing the overhead of SKB allocation and other
@@ -99,7 +109,8 @@ Features
overwritten by setting of synthetic NIC.
XDP program cannot run with LRO (RSC) enabled, so you need to disable LRO
- before running XDP:
+ before running XDP::
+
ethtool -K eth0 lro off
XDP_REDIRECT action is not yet supported.
diff --git a/MAINTAINERS b/MAINTAINERS
index 62c654308bc8..ef6bd3be1bb5 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7881,7 +7881,7 @@ S: Supported
T: git git://git.kernel.org/pub/scm/linux/kernel/git/hyperv/linux.git
F: Documentation/ABI/stable/sysfs-bus-vmbus
F: Documentation/ABI/testing/debugfs-hyperv
-F: Documentation/networking/device_drivers/microsoft/netvsc.txt
+F: Documentation/networking/device_drivers/microsoft/netvsc.rst
F: arch/x86/hyperv
F: arch/x86/include/asm/hyperv-tlfs.h
F: arch/x86/include/asm/mshyperv.h
--
2.25.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 00/37]net: manually convert files to ReST format - part 3 (final)
2020-05-01 14:44 [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) Mauro Carvalho Chehab
2020-05-01 14:44 ` [PATCH 26/37] docs: networking: device drivers: convert microsoft/netvsc.txt to ReST Mauro Carvalho Chehab
@ 2020-05-01 19:33 ` David Miller
1 sibling, 0 replies; 3+ messages in thread
From: David Miller @ 2020-05-01 19:33 UTC (permalink / raw)
To: mchehab+huawei
Cc: linux-doc, linux-kernel, corbet, chessman, netdev, andrew.hendry,
zorik, stranche, irusskikh, jdmason, haiyangz, linux-x25,
wei.liu, linux-hyperv, kvalo, kuba, subashab, dsahern, kys,
kou.ishizaki, jreuter, saeedb, shrijeet, netanel, stas.yakovlev,
gtzalik, maxk, akiyano, linux-wireless, linux-hams, linux-parisc,
klassert, sthemmin
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: Fri, 1 May 2020 16:44:22 +0200
> That's the third part (and the final one) of my work to convert the networking
> text files into ReST. it is based on linux-next next-20200430 branch.
>
> The full series (including those ones) are at:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
>
> The built output documents, on html format is at:
>
> https://www.infradead.org/~mchehab/kernel_docs/networking/
Series applied, thanks for doing all of this work.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-05-01 19:33 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-01 14:44 [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) Mauro Carvalho Chehab
2020-05-01 14:44 ` [PATCH 26/37] docs: networking: device drivers: convert microsoft/netvsc.txt to ReST Mauro Carvalho Chehab
2020-05-01 19:33 ` [PATCH 00/37]net: manually convert files to ReST format - part 3 (final) David Miller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).