Skip to contentSkip to conversation

net: manually convert files to ReST format - part 2

PATCH In review Mauro Carvalho Chehab 5 participants 42 messages Apr 30, 2020

Subsystems (23)
lore
Share & tools
lore
#0 lore raw

cover net: manually convert files to ReST format - part 2

That's the second part of my work to convert the networking text files into ReST. it is based on today's linux-next (next-20200430).

The full series (including those ones) are at:

https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs

I should be sending the remaining patches (another /38 series) after getting those merged at -next.

The documents, converted to HTML via the building system are at:

https://www.infradead.org/~mchehab/kernel_docs/networking/

Mauro Carvalho Chehab (37):
docs: networking: convert l2tp.txt to ReST
docs: networking: convert lapb-module.txt to ReST
docs: networking: convert ltpc.txt to ReST
docs: networking: convert mac80211-injection.txt to ReST
docs: networking: convert mpls-sysctl.txt to ReST
docs: networking: convert multiqueue.txt to ReST
docs: networking: convert netconsole.txt to ReST
docs: networking: convert netdev-features.txt to ReST
docs: networking: convert netdevices.txt to ReST
docs: networking: convert netfilter-sysctl.txt to ReST
docs: networking: convert netif-msg.txt to ReST
docs: networking: convert nf_conntrack-sysctl.txt to ReST
docs: networking: convert nf_flowtable.txt to ReST
docs: networking: convert openvswitch.txt to ReST
docs: networking: convert operstates.txt to ReST
docs: networking: convert packet_mmap.txt to ReST
docs: networking: convert phonet.txt to ReST
docs: networking: convert pktgen.txt to ReST
docs: networking: convert PLIP.txt to ReST
docs: networking: convert ppp_generic.txt to ReST
docs: networking: convert proc_net_tcp.txt to ReST
docs: networking: convert radiotap-headers.txt to ReST
docs: networking: convert ray_cs.txt to ReST
docs: networking: convert rds.txt to ReST
docs: networking: convert regulatory.txt to ReST
docs: networking: convert rxrpc.txt to ReST
docs: networking: convert sctp.txt to ReST
docs: networking: convert secid.txt to ReST
docs: networking: convert seg6-sysctl.txt to ReST
docs: networking: convert skfp.txt to ReST
docs: networking: convert strparser.txt to ReST
docs: networking: convert switchdev.txt to ReST
docs: networking: convert tc-actions-env-rules.txt to ReST
docs: networking: convert tcp-thin.txt to ReST
docs: networking: convert team.txt to ReST
docs: networking: convert timestamping.txt to ReST
docs: networking: convert tproxy.txt to ReST

 .../admin-guide/kernel-parameters.txt         |    2 +-
 Documentation/admin-guide/serial-console.rst  |    2 +-
 Documentation/filesystems/afs.rst             |    2 +-
 Documentation/networking/bonding.rst          |    2 +-
 Documentation/networking/can.rst              |    2 +-
 .../networking/checksum-offloads.rst          |    2 +-
 Documentation/networking/index.rst            |   37 +
 Documentation/networking/ip-sysctl.rst        |    2 +-
 .../networking/{l2tp.txt => l2tp.rst}         |  145 ++-
 .../{lapb-module.txt => lapb-module.rst}      |  120 +-
 .../networking/{ltpc.txt => ltpc.rst}         |   45 +-
 ...1-injection.txt => mac80211-injection.rst} |   41 +-
 .../{mpls-sysctl.txt => mpls-sysctl.rst}      |   17 +-
 .../{multiqueue.txt => multiqueue.rst}        |   41 +-
 .../{netconsole.txt => netconsole.rst}        |  125 +-
 ...etdev-features.txt => netdev-features.rst} |   19 +-
 .../{netdevices.txt => netdevices.rst}        |   21 +-
 ...filter-sysctl.txt => netfilter-sysctl.rst} |   11 +-
 Documentation/networking/netif-msg.rst        |   95 ++
 Documentation/networking/netif-msg.txt        |   79 --
 ...ack-sysctl.txt => nf_conntrack-sysctl.rst} |   51 +-
 .../{nf_flowtable.txt => nf_flowtable.rst}    |   55 +-
 .../{openvswitch.txt => openvswitch.rst}      |   23 +-
 .../{operstates.txt => operstates.rst}        |   45 +-
 Documentation/networking/packet_mmap.rst      | 1084 +++++++++++++++++
 Documentation/networking/packet_mmap.txt      | 1061 ----------------
 .../networking/{phonet.txt => phonet.rst}     |   56 +-
 .../networking/{pktgen.txt => pktgen.rst}     |  316 ++---
 .../networking/{PLIP.txt => plip.rst}         |   43 +-
 .../{ppp_generic.txt => ppp_generic.rst}      |   52 +-
 .../{proc_net_tcp.txt => proc_net_tcp.rst}    |   23 +-
 ...iotap-headers.txt => radiotap-headers.rst} |   99 +-
 .../networking/{ray_cs.txt => ray_cs.rst}     |  101 +-
 Documentation/networking/{rds.txt => rds.rst} |  295 +++--
 .../{regulatory.txt => regulatory.rst}        |   29 +-
 .../networking/{rxrpc.txt => rxrpc.rst}       |  306 ++---
 .../networking/{sctp.txt => sctp.rst}         |   37 +-
 .../networking/{secid.txt => secid.rst}       |    6 +
 Documentation/networking/seg6-sysctl.rst      |   26 +
 Documentation/networking/seg6-sysctl.txt      |   18 -
 .../networking/{skfp.txt => skfp.rst}         |  153 ++-
 .../{strparser.txt => strparser.rst}          |   85 +-
 .../{switchdev.txt => switchdev.rst}          |  114 +-
 .../networking/tc-actions-env-rules.rst       |   29 +
 .../networking/tc-actions-env-rules.txt       |   24 -
 .../networking/{tcp-thin.txt => tcp-thin.rst} |    5 +
 .../networking/{team.txt => team.rst}         |    6 +
 .../{timestamping.txt => timestamping.rst}    |  154 ++-
 .../networking/{tproxy.txt => tproxy.rst}     |   55 +-
 MAINTAINERS                                   |   14 +-
 drivers/net/Kconfig                           |    4 +-
 drivers/net/appletalk/Kconfig                 |    2 +-
 drivers/net/ethernet/toshiba/ps3_gelic_net.c  |    2 +-
 drivers/net/ethernet/toshiba/spider_net.c     |    2 +-
 drivers/net/fddi/Kconfig                      |    2 +-
 drivers/net/plip/Kconfig                      |    2 +-
 drivers/net/wireless/Kconfig                  |    2 +-
 drivers/staging/fsl-dpaa2/ethsw/README        |    2 +-
 include/linux/netdev_features.h               |    2 +-
 include/net/cfg80211.h                        |    2 +-
 include/uapi/linux/errqueue.h                 |    2 +-
 net/Kconfig                                   |    2 +-
 net/core/pktgen.c                             |    2 +-
 net/lapb/Kconfig                              |    2 +-
 net/mac80211/tx.c                             |    2 +-
 net/netfilter/Kconfig                         |    2 +-
 net/rxrpc/Kconfig                             |    6 +-
 net/rxrpc/sysctl.c                            |    2 +-
 net/wireless/radiotap.c                       |    2 +-
 samples/pktgen/README.rst                     |    2 +-
 70 files changed, 2864 insertions(+), 2357 deletions(-)
 rename Documentation/networking/{l2tp.txt => l2tp.rst} (79%)
 rename Documentation/networking/{lapb-module.txt => lapb-module.rst} (74%)
 rename Documentation/networking/{ltpc.txt => ltpc.rst} (86%)
 rename Documentation/networking/{mac80211-injection.txt => mac80211-injection.rst} (67%)
 rename Documentation/networking/{mpls-sysctl.txt => mpls-sysctl.rst} (82%)
 rename Documentation/networking/{multiqueue.txt => multiqueue.rst} (76%)
 rename Documentation/networking/{netconsole.txt => netconsole.rst} (66%)
 rename Documentation/networking/{netdev-features.txt => netdev-features.rst} (95%)
 rename Documentation/networking/{netdevices.txt => netdevices.rst} (89%)
 rename Documentation/networking/{netfilter-sysctl.txt => netfilter-sysctl.rst} (62%)
 create mode 100644 Documentation/networking/netif-msg.rst
 delete mode 100644 Documentation/networking/netif-msg.txt
 rename Documentation/networking/{nf_conntrack-sysctl.txt => nf_conntrack-sysctl.rst} (85%)
 rename Documentation/networking/{nf_flowtable.txt => nf_flowtable.rst} (76%)
 rename Documentation/networking/{openvswitch.txt => openvswitch.rst} (95%)
 rename Documentation/networking/{operstates.txt => operstates.rst} (87%)
 create mode 100644 Documentation/networking/packet_mmap.rst
 delete mode 100644 Documentation/networking/packet_mmap.txt
 rename Documentation/networking/{phonet.txt => phonet.rst} (82%)
 rename Documentation/networking/{pktgen.txt => pktgen.rst} (62%)
 rename Documentation/networking/{PLIP.txt => plip.rst} (92%)
 rename Documentation/networking/{ppp_generic.txt => ppp_generic.rst} (91%)
 rename Documentation/networking/{proc_net_tcp.txt => proc_net_tcp.rst} (83%)
 rename Documentation/networking/{radiotap-headers.txt => radiotap-headers.rst} (70%)
 rename Documentation/networking/{ray_cs.txt => ray_cs.rst} (65%)
 rename Documentation/networking/{rds.txt => rds.rst} (59%)
 rename Documentation/networking/{regulatory.txt => regulatory.rst} (94%)
 rename Documentation/networking/{rxrpc.txt => rxrpc.rst} (85%)
 rename Documentation/networking/{sctp.txt => sctp.rst} (64%)
 rename Documentation/networking/{secid.txt => secid.rst} (87%)
 create mode 100644 Documentation/networking/seg6-sysctl.rst
 delete mode 100644 Documentation/networking/seg6-sysctl.txt
 rename Documentation/networking/{skfp.txt => skfp.rst} (68%)
 rename Documentation/networking/{strparser.txt => strparser.rst} (80%)
 rename Documentation/networking/{switchdev.txt => switchdev.rst} (84%)
 create mode 100644 Documentation/networking/tc-actions-env-rules.rst
 delete mode 100644 Documentation/networking/tc-actions-env-rules.txt
 rename Documentation/networking/{tcp-thin.txt => tcp-thin.rst} (97%)
 rename Documentation/networking/{team.txt => team.rst} (67%)
 rename Documentation/networking/{timestamping.txt => timestamping.rst} (89%)
 rename Documentation/networking/{tproxy.txt => tproxy.rst} (70%)
Signature · 1 line
2.25.4
#2 lore raw

PATCH 2/37 docs: networking: convert lapb-module.txt to ReST

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../{lapb-module.txt => lapb-module.rst}      | 120 ++++++++++++------
 MAINTAINERS                                   |   2 +-
 net/lapb/Kconfig                              |   2 +-
 4 files changed, 84 insertions(+), 41 deletions(-)
 rename Documentation/networking/{lapb-module.txt => lapb-module.rst} (74%)
Documentation/networking/index.rst +1 -0
index 0c5d7a037983..acd2567cf0d4 100644
@@ -75,6 +75,7 @@ Contents:
    ipvs-sysctl
    kcm
    l2tp
+   lapb-module
 
 .. only::  subproject and html
 
Documentation/networking/lapb-module.rst renamed from Documentation/networking/lapb-module.txt +81 -39

284 lines not on this page · raw message

MAINTAINERS +1 -1
index b0cf6c358136..0db63acd07b0 100644
@@ -9546,7 +9546,7 @@ F:	drivers/soc/lantiq
 LAPB module
 L:	[email protected]
 S:	Orphan
-F:	Documentation/networking/lapb-module.txt
+F:	Documentation/networking/lapb-module.rst
 F:	include/*/lapb.h
 F:	net/lapb/
 
net/lapb/Kconfig +1 -1
index 6acfc999c952..5b50e8d64f26 100644
@@ -15,7 +15,7 @@ config LAPB
 	  currently supports LAPB only over Ethernet connections. If you want
 	  to use LAPB connections over Ethernet, say Y here and to "LAPB over
 	  Ethernet driver" below. Read
-	  <file:Documentation/networking/lapb-module.txt> for technical
+	  <file:Documentation/networking/lapb-module.rst> for technical
 	  details.
 
 	  To compile this driver as a module, choose M here: the
Signature · 1 line
2.25.4
#9 lore raw

PATCH 9/37 docs: networking: convert netdevices.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/can.rst              |  2 +-
 Documentation/networking/index.rst            |  1 +
 .../{netdevices.txt => netdevices.rst}        | 21 ++++++++++++-------
 3 files changed, 16 insertions(+), 8 deletions(-)
 rename Documentation/networking/{netdevices.txt => netdevices.rst} (89%)
Documentation/networking/can.rst +1 -1
index 2fd0b51a8c52..ff05cbd05e0d 100644
@@ -1058,7 +1058,7 @@ drivers you mainly have to deal with:
 - TX: Put the CAN frame from the socket buffer to the CAN controller.
 - RX: Put the CAN frame from the CAN controller to the socket buffer.
 
-See e.g. at Documentation/networking/netdevices.txt . The differences
+See e.g. at Documentation/networking/netdevices.rst . The differences
 for writing CAN network device driver are described below:
 
 
Documentation/networking/index.rst +1 -0
index 4c6aa3db97d4..5a320553ffba 100644
@@ -82,6 +82,7 @@ Contents:
    multiqueue
    netconsole
    netdev-features
+   netdevices
 
 .. only::  subproject and html
 
Documentation/networking/netdevices.rst renamed from Documentation/networking/netdevices.txt +14 -7
similarity index 89%
rename from Documentation/networking/netdevices.txt
rename to Documentation/networking/netdevices.rst
index 7fec2061a334..5a85fcc80c76 100644
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
 
+=====================================
 Network Devices, the Kernel, and You!
+=====================================
 
 
 Introduction
@@ -75,11 +78,12 @@ ndo_start_xmit:
 	Don't use it for new drivers.
 
 	Context: Process with BHs disabled or BH (timer),
-	         will be called with interrupts disabled by netconsole.
+		 will be called with interrupts disabled by netconsole.
 
-	Return codes: 
-	o NETDEV_TX_OK everything ok. 
-	o NETDEV_TX_BUSY Cannot transmit packet, try later 
+	Return codes:
+
+	* NETDEV_TX_OK everything ok.
+	* NETDEV_TX_BUSY Cannot transmit packet, try later
 	  Usually a bug, means queue start/stop flow control is broken in
 	  the driver. Note: the driver must NOT put the skb in its DMA ring.
 
@@ -95,10 +99,13 @@ ndo_set_rx_mode:
 struct napi_struct synchronization rules
 ========================================
 napi->poll:
-	Synchronization: NAPI_STATE_SCHED bit in napi->state.  Device
+	Synchronization:
+		NAPI_STATE_SCHED bit in napi->state.  Device
 		driver's ndo_stop method will invoke napi_disable() on
 		all NAPI instances which will do a sleeping poll on the
 		NAPI_STATE_SCHED napi->state bit, waiting for all pending
 		NAPI activity to cease.
-	Context: softirq
-	         will be called with interrupts disabled by netconsole.
+
+	Context:
+		 softirq
+		 will be called with interrupts disabled by netconsole.
Signature · 1 line
2.25.4
#29 lore raw

PATCH 27/37 docs: networking: convert sctp.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/{sctp.txt => sctp.rst}         | 37 +++++++++++--------
 MAINTAINERS                                   |  2 +-
 3 files changed, 24 insertions(+), 16 deletions(-)
 rename Documentation/networking/{sctp.txt => sctp.rst} (64%)
Documentation/networking/index.rst +1 -0
index cd307b9601fa..1761eb715061 100644
@@ -100,6 +100,7 @@ Contents:
    rds
    regulatory
    rxrpc
+   sctp
 
 .. only::  subproject and html
 
Documentation/networking/sctp.rst renamed from Documentation/networking/sctp.txt +21 -15
similarity index 64%
rename from Documentation/networking/sctp.txt
rename to Documentation/networking/sctp.rst
index 97b810ca9082..9f4d9c8a925b 100644
@@ -1,35 +1,42 @@
-Linux Kernel SCTP 
+.. SPDX-License-Identifier: GPL-2.0
+
+========+Linux Kernel SCTP
+======== 
 This is the current BETA release of the Linux Kernel SCTP reference
-implementation.  
+implementation.
 
 SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
 reliable transport protocol, with congestion control, support for
 transparent multi-homing, and multiple ordered streams of messages.
 RFC2960 defines the core protocol.  The IETF SIGTRAN working group originally
-developed the SCTP protocol and later handed the protocol over to the 
-Transport Area (TSVWG) working group for the continued evolvement of SCTP as a 
-general purpose transport.  
+developed the SCTP protocol and later handed the protocol over to the
+Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
+general purpose transport.
 
-See the IETF website (http://www.ietf.org) for further documents on SCTP. 
-See http://www.ietf.org/rfc/rfc2960.txt 
+See the IETF website (http://www.ietf.org) for further documents on SCTP.
+See http://www.ietf.org/rfc/rfc2960.txt
 
 The initial project goal is to create an Linux kernel reference implementation
-of SCTP that is RFC 2960 compliant and provides an programming interface 
-referred to as the  UDP-style API of the Sockets Extensions for SCTP, as 
-proposed in IETF Internet-Drafts.    
+of SCTP that is RFC 2960 compliant and provides an programming interface
+referred to as the  UDP-style API of the Sockets Extensions for SCTP, as
+proposed in IETF Internet-Drafts.
 
-Caveats:  
+Caveats
+=== 
--lksctp can be built as statically or as a module.  However, be aware that 
-module removal of lksctp is not yet a safe activity.   
+- lksctp can be built as statically or as a module.  However, be aware that
+  module removal of lksctp is not yet a safe activity.
 
--There is tentative support for IPv6, but most work has gone towards 
-implementation and testing lksctp on IPv4.   
+- There is tentative support for IPv6, but most work has gone towards
+  implementation and testing lksctp on IPv4.
 
 
 For more information, please visit the lksctp project website:
+
    http://www.sf.net/projects/lksctp
 
 Or contact the lksctp developers through the mailing list:
+
    <[email protected]>
MAINTAINERS +1 -1
index 93e1b253ae51..64789b29c085 100644
@@ -15044,7 +15044,7 @@ M:	Marcelo Ricardo Leitner <[email protected]>
 L:	[email protected]
 S:	Maintained
 W:	http://lksctp.sourceforge.net
-F:	Documentation/networking/sctp.txt
+F:	Documentation/networking/sctp.rst
 F:	include/linux/sctp.h
 F:	include/net/sctp/
 F:	include/uapi/linux/sctp.h
Signature · 1 line
2.25.4
#5 lore raw

PATCH 5/37 docs: networking: convert mpls-sysctl.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst              |  1 +
 .../{mpls-sysctl.txt => mpls-sysctl.rst}        | 17 +++++++++++++----
 2 files changed, 14 insertions(+), 4 deletions(-)
 rename Documentation/networking/{mpls-sysctl.txt => mpls-sysctl.rst} (82%)
Documentation/networking/index.rst +1 -0
index 81c1834bfb57..a751cda83c3d 100644
@@ -78,6 +78,7 @@ Contents:
    lapb-module
    ltpc
    mac80211-injection
+   mpls-sysctl
 
 .. only::  subproject and html
 
Documentation/networking/mpls-sysctl.rst renamed from Documentation/networking/mpls-sysctl.txt +13 -4
similarity index 82%
rename from Documentation/networking/mpls-sysctl.txt
rename to Documentation/networking/mpls-sysctl.rst
index 025cc9b96992..0a2ac88404d7 100644
@@ -1,4 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+MPLS Sysfs variables
+====================
+
 /proc/sys/net/mpls/* Variables:
+===============================
 
 platform_labels - INTEGER
 	Number of entries in the platform label table.  It is not
@@ -17,6 +24,7 @@ platform_labels - INTEGER
 	no longer fit in the table.
 
 	Possible values: 0 - 1048575
+
 	Default: 0
 
 ip_ttl_propagate - BOOL
@@ -27,8 +35,8 @@ ip_ttl_propagate - BOOL
 	If disabled, the MPLS transport network will appear as a
 	single hop to transit traffic.
 
-	0 - disabled / RFC 3443 [Short] Pipe Model
-	1 - enabled / RFC 3443 Uniform Model (default)
+	* 0 - disabled / RFC 3443 [Short] Pipe Model
+	* 1 - enabled / RFC 3443 Uniform Model (default)
 
 default_ttl - INTEGER
 	Default TTL value to use for MPLS packets where it cannot be
@@ -36,6 +44,7 @@ default_ttl - INTEGER
 	or ip_ttl_propagate has been disabled.
 
 	Possible values: 1 - 255
+
 	Default: 255
 
 conf/<interface>/input - BOOL
@@ -44,5 +53,5 @@ conf/<interface>/input - BOOL
 	If disabled, packets will be discarded without further
 	processing.
 
-	0 - disabled (default)
-	not 0 - enabled
+	* 0 - disabled (default)
+	* not 0 - enabled
Signature · 1 line
2.25.4
#4 lore raw

PATCH 4/37 docs: networking: convert mac80211-injection.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 ...1-injection.txt => mac80211-injection.rst} | 39 ++++++++++++-------
 MAINTAINERS                                   |  2 +-
 net/mac80211/tx.c                             |  2 +-
 4 files changed, 27 insertions(+), 17 deletions(-)
 rename Documentation/networking/{mac80211-injection.txt => mac80211-injection.rst} (68%)
Documentation/networking/index.rst +1 -0
index b3608b177a8b..81c1834bfb57 100644
@@ -77,6 +77,7 @@ Contents:
    l2tp
    lapb-module
    ltpc
+   mac80211-injection
 
 .. only::  subproject and html
 
Documentation/networking/mac80211-injection.rst renamed from Documentation/networking/mac80211-injection.txt +24 -15
similarity index 68%
rename from Documentation/networking/mac80211-injection.txt
rename to Documentation/networking/mac80211-injection.rst
index d58d78df9ca2..75d4edcae852 100644
@@ -1,9 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================================
 How to use packet injection with mac80211
 =========================================
 
 mac80211 now allows arbitrary packets to be injected down any Monitor Mode
 interface from userland.  The packet you inject needs to be composed in the
-following format:
+following format::
 
  [ radiotap header  ]
  [ ieee80211 header ]
@@ -18,15 +21,19 @@ radiotap headers and used to control injection:
 
  * IEEE80211_RADIOTAP_FLAGS
 
-   IEEE80211_RADIOTAP_F_FCS: FCS will be removed and recalculated
-   IEEE80211_RADIOTAP_F_WEP: frame will be encrypted if key available
-   IEEE80211_RADIOTAP_F_FRAG: frame will be fragmented if longer than the
+   =========================  ===========================================
+   IEEE80211_RADIOTAP_F_FCS   FCS will be removed and recalculated
+   IEEE80211_RADIOTAP_F_WEP   frame will be encrypted if key available
+   IEEE80211_RADIOTAP_F_FRAG  frame will be fragmented if longer than the
 			      current fragmentation threshold.
+   =========================  ===========================================
 
  * IEEE80211_RADIOTAP_TX_FLAGS
 
-   IEEE80211_RADIOTAP_F_TX_NOACK: frame should be sent without waiting for
+   =============================  ========================================
+   IEEE80211_RADIOTAP_F_TX_NOACK  frame should be sent without waiting for
 				  an ACK even if it is a unicast frame
+   =============================  ========================================
 
  * IEEE80211_RADIOTAP_RATE
 
@@ -37,8 +44,10 @@ radiotap headers and used to control injection:
    HT rate for the transmission (only for devices without own rate control).
    Also some flags are parsed
 
-   IEEE80211_RADIOTAP_MCS_SGI: use short guard interval
-   IEEE80211_RADIOTAP_MCS_BW_40: send in HT40 mode
+   ============================  ========================
+   IEEE80211_RADIOTAP_MCS_SGI    use short guard interval
+   IEEE80211_RADIOTAP_MCS_BW_40  send in HT40 mode
+   ============================  ========================
 
  * IEEE80211_RADIOTAP_DATA_RETRIES
 
@@ -51,17 +60,17 @@ radiotap headers and used to control injection:
    without own rate control). Also other fields are parsed
 
    flags field
-   IEEE80211_RADIOTAP_VHT_FLAG_SGI: use short guard interval
+	IEEE80211_RADIOTAP_VHT_FLAG_SGI: use short guard interval
 
    bandwidth field
-   1: send using 40MHz channel width
-   4: send using 80MHz channel width
-   11: send using 160MHz channel width
+	* 1: send using 40MHz channel width
+	* 4: send using 80MHz channel width
+	* 11: send using 160MHz channel width
 
 The injection code can also skip all other currently defined radiotap fields
 facilitating replay of captured radiotap headers directly.
 
-Here is an example valid radiotap header defining some parameters
+Here is an example valid radiotap header defining some parameters::
 
 	0x00, 0x00, // <-- radiotap version
 	0x0b, 0x00, // <- radiotap header length
@@ -71,7 +80,7 @@ Here is an example valid radiotap header defining some parameters
 	0x01 //<-- antenna
 
 The ieee80211 header follows immediately afterwards, looking for example like
-this:
+this::
 
 	0x08, 0x01, 0x00, 0x00,
 	0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
@@ -84,10 +93,10 @@ Then lastly there is the payload.
 After composing the packet contents, it is sent by send()-ing it to a logical
 mac80211 interface that is in Monitor mode.  Libpcap can also be used,
 (which is easier than doing the work to bind the socket to the right
-interface), along the following lines:
+interface), along the following lines:::
 
 	ppcap = pcap_open_live(szInterfaceName, 800, 1, 20, szErrbuf);
-...
+	...
 	r = pcap_inject(ppcap, u8aSendBuffer, nLength);
 
 You can also find a link to a complete inject application here:
MAINTAINERS +1 -1
index 0db63acd07b0..1546ecb855b5 100644
@@ -10112,7 +10112,7 @@ S:	Maintained
 W:	https://wireless.wiki.kernel.org/
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git
-F:	Documentation/networking/mac80211-injection.txt
+F:	Documentation/networking/mac80211-injection.rst
 F:	Documentation/networking/mac80211_hwsim/mac80211_hwsim.rst
 F:	drivers/net/wireless/mac80211_hwsim.[ch]
 F:	include/net/mac80211.h
net/mac80211/tx.c +1 -1
index 6dad67eb60b2..47f460c8bd74 100644
@@ -2144,7 +2144,7 @@ static bool ieee80211_parse_tx_radiotap(struct ieee80211_local *local,
 
 		/*
 		 * Please update the file
-		 * Documentation/networking/mac80211-injection.txt
+		 * Documentation/networking/mac80211-injection.rst
 		 * when parsing new fields here.
 		 */
 
Signature · 1 line
2.25.4
#14 lore raw

PATCH 14/37 docs: networking: convert openvswitch.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{openvswitch.txt => openvswitch.rst}      | 23 +++++++++++--------
 2 files changed, 14 insertions(+), 10 deletions(-)
 rename Documentation/networking/{openvswitch.txt => openvswitch.rst} (95%)
Documentation/networking/index.rst +1 -0
index c4e8a43741be..b7f558480aca 100644
@@ -87,6 +87,7 @@ Contents:
    netif-msg
    nf_conntrack-sysctl
    nf_flowtable
+   openvswitch
 
 .. only::  subproject and html
 
Documentation/networking/openvswitch.rst renamed from Documentation/networking/openvswitch.txt +13 -10
similarity index 95%
rename from Documentation/networking/openvswitch.txt
rename to Documentation/networking/openvswitch.rst
index b3b9ac61d29d..1a8353dbf1b6 100644
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================================
 Open vSwitch datapath developer documentation
 =============================================
 
@@ -80,13 +83,13 @@ The <linux/openvswitch.h> header file defines the exact format of the
 flow key attributes.  For informal explanatory purposes here, we write
 them as comma-separated strings, with parentheses indicating arguments
 and nesting.  For example, the following could represent a flow key
-corresponding to a TCP packet that arrived on vport 1:
+corresponding to a TCP packet that arrived on vport 1::
 
     in_port(1), eth(src=e0:91:f5:21:d0:b2, dst=00:02:e3:0f:80:a4),
     eth_type(0x0800), ipv4(src=172.16.0.20, dst=172.18.0.52, proto=17, tos=0,
     frag=no), tcp(src=49163, dst=80)
 
-Often we ellipsize arguments not important to the discussion, e.g.:
+Often we ellipsize arguments not important to the discussion, e.g.::
 
     in_port(1), eth(...), eth_type(0x0800), ipv4(...), tcp(...)
 
@@ -151,20 +154,20 @@ Some care is needed to really maintain forward and backward
 compatibility for applications that follow the rules listed under
 "Flow key compatibility" above.
 
-The basic rule is obvious:
+The basic rule is obvious::
 
-    ------------------------------------------------------------------
+    ==================================================================
     New network protocol support must only supplement existing flow
     key attributes.  It must not change the meaning of already defined
     flow key attributes.
-    ------------------------------------------------------------------
+    ==================================================================
 
 This rule does have less-obvious consequences so it is worth working
 through a few examples.  Suppose, for example, that the kernel module
 did not already implement VLAN parsing.  Instead, it just interpreted
 the 802.1Q TPID (0x8100) as the Ethertype then stopped parsing the
 packet.  The flow key for any packet with an 802.1Q header would look
-essentially like this, ignoring metadata:
+essentially like this, ignoring metadata::
 
     eth(...), eth_type(0x8100)
 
@@ -172,7 +175,7 @@ Naively, to add VLAN support, it makes sense to add a new "vlan" flow
 key attribute to contain the VLAN tag, then continue to decode the
 encapsulated headers beyond the VLAN tag using the existing field
 definitions.  With this change, a TCP packet in VLAN 10 would have a
-flow key much like this:
+flow key much like this::
 
     eth(...), vlan(vid=10, pcp=0), eth_type(0x0800), ip(proto=6, ...), tcp(...)
 
@@ -187,7 +190,7 @@ across kernel versions even though it follows the compatibility rules.
 
 The solution is to use a set of nested attributes.  This is, for
 example, why 802.1Q support uses nested attributes.  A TCP packet in
-VLAN 10 is actually expressed as:
+VLAN 10 is actually expressed as::
 
     eth(...), eth_type(0x8100), vlan(vid=10, pcp=0), encap(eth_type(0x0800),
     ip(proto=6, ...), tcp(...)))
@@ -215,14 +218,14 @@ For example, consider a packet that contains an IP header that
 indicates protocol 6 for TCP, but which is truncated just after the IP
 header, so that the TCP header is missing.  The flow key for this
 packet would include a tcp attribute with all-zero src and dst, like
-this:
+this::
 
     eth(...), eth_type(0x0800), ip(proto=6, ...), tcp(src=0, dst=0)
 
 As another example, consider a packet with an Ethernet type of 0x8100,
 indicating that a VLAN TCI should follow, but which is truncated just
 after the Ethernet type.  The flow key for this packet would include
-an all-zero-bits vlan and an empty encap attribute, like this:
+an all-zero-bits vlan and an empty encap attribute, like this::
 
     eth(...), eth_type(0x8100), vlan(0), encap()
 
Signature · 1 line
2.25.4
#31 lore raw

PATCH 28/37 docs: networking: convert secid.txt to ReST

In reply to Mauro Carvalho Chehab

Not much to be done here:
- add SPDX header;
- add a document title;
- add to networking/index.rst.

---
 Documentation/networking/index.rst                | 1 +
 Documentation/networking/{secid.txt => secid.rst} | 6 ++++++
 2 files changed, 7 insertions(+)
 rename Documentation/networking/{secid.txt => secid.rst} (87%)
Documentation/networking/index.rst +1 -0
index 1761eb715061..8b672f252f67 100644
@@ -101,6 +101,7 @@ Contents:
    regulatory
    rxrpc
    sctp
+   secid
 
 .. only::  subproject and html
 
Documentation/networking/secid.rst renamed from Documentation/networking/secid.txt +6 -0
similarity index 87%
rename from Documentation/networking/secid.txt
rename to Documentation/networking/secid.rst
index 95ea06784333..b45141a98027 100644
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================
+LSM/SeLinux secid
+=================
+
 flowi structure:
 
 The secid member in the flow structure is used in LSMs (e.g. SELinux) to indicate
Signature · 1 line
2.25.4
#33 lore raw

PATCH 30/37 docs: networking: convert skfp.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- use copyright symbol;
- add a document title;
- adjust titles and chapters, adding proper markups;
- comment out text-only TOC from html/pdf output;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../networking/{skfp.txt => skfp.rst}         | 153 +++++++++++-------
 drivers/net/fddi/Kconfig                      |   2 +-
 3 files changed, 95 insertions(+), 61 deletions(-)
 rename Documentation/networking/{skfp.txt => skfp.rst} (68%)
Documentation/networking/index.rst +1 -0
index 716744c568b7..d19ddcbe66e5 100644
@@ -103,6 +103,7 @@ Contents:
    sctp
    secid
    seg6-sysctl
+   skfp
 
 .. only::  subproject and html
 
Documentation/networking/skfp.rst renamed from Documentation/networking/skfp.txt +93 -60

304 lines not on this page · raw message

drivers/net/fddi/Kconfig +1 -1
index 3b412a56f2cb..da4f58eed08f 100644
@@ -77,7 +77,7 @@ config SKFP
 	  - Netelligent 100 FDDI SAS UTP
 	  - Netelligent 100 FDDI SAS Fibre MIC
 
-	  Read <file:Documentation/networking/skfp.txt> for information about
+	  Read <file:Documentation/networking/skfp.rst> for information about
 	  the driver.
 
 	  Questions concerning this driver can be addressed to:
Signature · 1 line
2.25.4
#23 lore raw

PATCH 22/37 docs: networking: convert radiotap-headers.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/mac80211-injection.rst         |  2 +-
 ...iotap-headers.txt => radiotap-headers.rst} | 99 ++++++++++---------
 include/net/cfg80211.h                        |  2 +-
 net/wireless/radiotap.c                       |  2 +-
 5 files changed, 57 insertions(+), 49 deletions(-)
 rename Documentation/networking/{radiotap-headers.txt => radiotap-headers.rst} (70%)
Documentation/networking/index.rst +1 -0
index 0da7eb0ec85a..85bc52d0b3a6 100644
@@ -95,6 +95,7 @@ Contents:
    plip
    ppp_generic
    proc_net_tcp
+   radiotap-headers
 
 .. only::  subproject and html
 
Documentation/networking/mac80211-injection.rst +1 -1
index 75d4edcae852..be65f886ff1f 100644
@@ -13,7 +13,7 @@ following format::
  [ payload ]
 
 The radiotap format is discussed in
-./Documentation/networking/radiotap-headers.txt.
+./Documentation/networking/radiotap-headers.rst.
 
 Despite many radiotap parameters being currently defined, most only make sense
 to appear on received packets.  The following information is parsed from the
Documentation/networking/radiotap-headers.rst renamed from Documentation/networking/radiotap-headers.txt +53 -46

141 lines not on this page · raw message

include/net/cfg80211.h +1 -1
index e67897fabacd..582881d67f70 100644
@@ -5300,7 +5300,7 @@ u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
  * Radiotap parsing functions -- for controlled injection support
  *
  * Implemented in net/wireless/radiotap.c
- * Documentation in Documentation/networking/radiotap-headers.txt
+ * Documentation in Documentation/networking/radiotap-headers.rst
  */
 
 struct radiotap_align_size {
net/wireless/radiotap.c +1 -1
index 6582d155e2fc..d5e28239e030 100644
@@ -90,7 +90,7 @@ static const struct ieee80211_radiotap_namespace radiotap_ns = {
  * iterator.this_arg for type "type" safely on all arches.
  *
  * Example code:
- * See Documentation/networking/radiotap-headers.txt
+ * See Documentation/networking/radiotap-headers.rst
  */
 
 int ieee80211_radiotap_iterator_init(
Signature · 1 line
2.25.4
#13 lore raw

PATCH 13/37 docs: networking: convert nf_flowtable.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- add notes markups;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{nf_flowtable.txt => nf_flowtable.rst}    | 55 ++++++++++---------
 2 files changed, 31 insertions(+), 25 deletions(-)
 rename Documentation/networking/{nf_flowtable.txt => nf_flowtable.rst} (76%)
Documentation/networking/index.rst +1 -0
index e5128bb7e7df..c4e8a43741be 100644
@@ -86,6 +86,7 @@ Contents:
    netfilter-sysctl
    netif-msg
    nf_conntrack-sysctl
+   nf_flowtable
 
 .. only::  subproject and html
 
Documentation/networking/nf_flowtable.rst renamed from Documentation/networking/nf_flowtable.txt +30 -25

85 lines not on this page · raw message

Signature · 1 line
2.25.4
#16 lore raw

PATCH 16/37 docs: networking: convert packet_mmap.txt to ReST

In reply to Mauro Carvalho Chehab

This patch has a big diff, but most are due to whitespaces.

Yet, the conversion is similar to other files under networking:

- add SPDX header;
- add a document title;
- adjust titles and chapters, adding proper markups;
- mark lists as such;
- mark tables as such;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst       |    1 +
 Documentation/networking/packet_mmap.rst | 1084 ++++++++++++++++++++++
 Documentation/networking/packet_mmap.txt | 1061 ---------------------
 3 files changed, 1085 insertions(+), 1061 deletions(-)
 create mode 100644 Documentation/networking/packet_mmap.rst
 delete mode 100644 Documentation/networking/packet_mmap.txt
Documentation/networking/index.rst +1 -0
index 028a36821b9a..8262b535a83e 100644
@@ -89,6 +89,7 @@ Contents:
    nf_flowtable
    openvswitch
    operstates
+   packet_mmap
 
 .. only::  subproject and html
 
Documentation/networking/packet_mmap.rst new file +1084 -0

1,084 lines not on this page · raw message

Documentation/networking/packet_mmap.txt deleted +0 -1061

1,061 lines not on this page · raw message

Signature · 1 line
2.25.4
#28 lore raw

PATCH 26/37 docs: networking: convert rxrpc.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- use autonumbered list markups;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/filesystems/afs.rst             |   2 +-
 Documentation/networking/index.rst            |   1 +
 .../networking/{rxrpc.txt => rxrpc.rst}       | 306 +++++++++---------
 MAINTAINERS                                   |   2 +-
 net/rxrpc/Kconfig                             |   6 +-
 net/rxrpc/sysctl.c                            |   2 +-
 6 files changed, 167 insertions(+), 152 deletions(-)
 rename Documentation/networking/{rxrpc.txt => rxrpc.rst} (85%)
Documentation/filesystems/afs.rst +1 -1
index c4ec39a5966e..cada9464d6bd 100644
@@ -70,7 +70,7 @@ list of volume location server IP addresses::
 The first module is the AF_RXRPC network protocol driver.  This provides the
 RxRPC remote operation protocol and may also be accessed from userspace.  See:
 
-	Documentation/networking/rxrpc.txt
+	Documentation/networking/rxrpc.rst
 
 The second module is the kerberos RxRPC security driver, and the third module
 is the actual filesystem driver for the AFS filesystem.
Documentation/networking/index.rst +1 -0
index bc3b04a2edde..cd307b9601fa 100644
@@ -99,6 +99,7 @@ Contents:
    ray_cs
    rds
    regulatory
+   rxrpc
 
 .. only::  subproject and html
 
Documentation/networking/rxrpc.rst renamed from Documentation/networking/rxrpc.txt +160 -146

888 lines not on this page · raw message

MAINTAINERS +1 -1
index caab14c5c12b..93e1b253ae51 100644
@@ -14637,7 +14637,7 @@ M:	David Howells <[email protected]>
 L:	[email protected]
 S:	Supported
 W:	https://www.infradead.org/~dhowells/kafs/
-F:	Documentation/networking/rxrpc.txt
+F:	Documentation/networking/rxrpc.rst
 F:	include/keys/rxrpc-type.h
 F:	include/net/af_rxrpc.h
 F:	include/trace/events/rxrpc.h
net/rxrpc/Kconfig +3 -3
index 57ebb29c26ad..d706bb408365 100644
@@ -18,7 +18,7 @@ config AF_RXRPC
 	  This module at the moment only supports client operations and is
 	  currently incomplete.
 
-	  See Documentation/networking/rxrpc.txt.
+	  See Documentation/networking/rxrpc.rst.
 
 config AF_RXRPC_IPV6
 	bool "IPv6 support for RxRPC"
@@ -41,7 +41,7 @@ config AF_RXRPC_DEBUG
 	help
 	  Say Y here to make runtime controllable debugging messages appear.
 
-	  See Documentation/networking/rxrpc.txt.
+	  See Documentation/networking/rxrpc.rst.
 
 
 config RXKAD
@@ -56,4 +56,4 @@ config RXKAD
 	  Provide kerberos 4 and AFS kaserver security handling for AF_RXRPC
 	  through the use of the key retention service.
 
-	  See Documentation/networking/rxrpc.txt.
+	  See Documentation/networking/rxrpc.rst.
net/rxrpc/sysctl.c +1 -1
index 2bbb38161851..174e903e18de 100644
@@ -21,7 +21,7 @@ static const unsigned long max_jiffies = MAX_JIFFY_OFFSET;
 /*
  * RxRPC operating parameters.
  *
- * See Documentation/networking/rxrpc.txt and the variable definitions for more
+ * See Documentation/networking/rxrpc.rst and the variable definitions for more
  * information on the individual parameters.
  */
 static struct ctl_table rxrpc_sysctl_table[] = {
Signature · 1 line
2.25.4
#25 lore raw

PATCH 24/37 docs: networking: convert rds.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- mark lists as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 Documentation/networking/{rds.txt => rds.rst} | 295 ++++++++++--------
 MAINTAINERS                                   |   2 +-
 3 files changed, 162 insertions(+), 136 deletions(-)
 rename Documentation/networking/{rds.txt => rds.rst} (59%)
Documentation/networking/index.rst +1 -0
index b7e35b0d905c..e63a2cb2e4cb 100644
@@ -97,6 +97,7 @@ Contents:
    proc_net_tcp
    radiotap-headers
    ray_cs
+   rds
 
 .. only::  subproject and html
 
Documentation/networking/rds.rst renamed from Documentation/networking/rds.txt +160 -135

399 lines not on this page · raw message

MAINTAINERS +1 -1
index 0d2005e8380e..d525b85a37a0 100644
@@ -14254,7 +14254,7 @@ L:	[email protected]
 L:	[email protected] (moderated for non-subscribers)
 S:	Supported
 W:	https://oss.oracle.com/projects/rds/
-F:	Documentation/networking/rds.txt
+F:	Documentation/networking/rds.rst
 F:	net/rds/
 
 RDT - RESOURCE ALLOCATION
Signature · 1 line
2.25.4
#39 lore raw

PATCH 36/37 docs: networking: convert timestamping.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- 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.

---
 Documentation/networking/index.rst            |   1 +
 Documentation/networking/packet_mmap.rst      |   4 +-
 .../{timestamping.txt => timestamping.rst}    | 154 ++++++++++--------
 include/uapi/linux/errqueue.h                 |   2 +-
 4 files changed, 91 insertions(+), 70 deletions(-)
 rename Documentation/networking/{timestamping.txt => timestamping.rst} (89%)
Documentation/networking/index.rst +1 -0
index be65ee509669..8f9a84b8e3f2 100644
@@ -109,6 +109,7 @@ Contents:
    tc-actions-env-rules
    tcp-thin
    team
+   timestamping
 
 .. only::  subproject and html
 
Documentation/networking/packet_mmap.rst +2 -2
index 884c7222b9e9..6c009ceb1183 100644
@@ -1030,7 +1030,7 @@ the packet meta information for mmap(2)ed RX_RING and TX_RINGs.  If your
 NIC is capable of timestamping packets in hardware, you can request those
 hardware timestamps to be used. Note: you may need to enable the generation
 of hardware timestamps with SIOCSHWTSTAMP (see related information from
-Documentation/networking/timestamping.txt).
+Documentation/networking/timestamping.rst).
 
 PACKET_TIMESTAMP accepts the same integer bit field as SO_TIMESTAMPING::
 
@@ -1069,7 +1069,7 @@ TX_RING part only TP_STATUS_AVAILABLE is set, then the tp_sec and tp_{n,u}sec
 members do not contain a valid value. For TX_RINGs, by default no timestamp
 is generated!
 
-See include/linux/net_tstamp.h and Documentation/networking/timestamping.txt
+See include/linux/net_tstamp.h and Documentation/networking/timestamping.rst
 for more information on hardware timestamps.
 
 Miscellaneous bits
Documentation/networking/timestamping.rst renamed from Documentation/networking/timestamping.txt +87 -67

364 lines not on this page · raw message

include/uapi/linux/errqueue.h +1 -1
index 0cca19670fd2..ca5cb3e3c6df 100644
@@ -36,7 +36,7 @@ struct sock_extended_err {
  *
  *	The timestamping interfaces SO_TIMESTAMPING, MSG_TSTAMP_*
  *	communicate network timestamps by passing this struct in a cmsg with
- *	recvmsg(). See Documentation/networking/timestamping.txt for details.
+ *	recvmsg(). See Documentation/networking/timestamping.rst for details.
  *	User space sees a timespec definition that matches either
  *	__kernel_timespec or __kernel_old_timespec, in the kernel we
  *	require two structure definitions to provide both.
Signature · 1 line
2.25.4
#35 lore raw

PATCH 32/37 docs: networking: convert switchdev.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- use copyright symbol;
- adjust title markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../{switchdev.txt => switchdev.rst}          | 114 ++++++++++--------
 drivers/staging/fsl-dpaa2/ethsw/README        |   2 +-
 3 files changed, 66 insertions(+), 51 deletions(-)
 rename Documentation/networking/{switchdev.txt => switchdev.rst} (84%)
Documentation/networking/index.rst +1 -0
index e5a705024c6a..5e495804f96f 100644
@@ -105,6 +105,7 @@ Contents:
    seg6-sysctl
    skfp
    strparser
+   switchdev
 
 .. only::  subproject and html
 
Documentation/networking/switchdev.rst renamed from Documentation/networking/switchdev.txt +64 -50

197 lines not on this page · raw message

drivers/staging/fsl-dpaa2/ethsw/README +1 -1
index f6fc07f780d1..b48dcbf7c5fb 100644
@@ -79,7 +79,7 @@ The DPSW can have ports connected to DPNIs or to PHYs via DPMACs.
 
 For a more detailed description of the Ethernet switch device driver model
 see:
-	Documentation/networking/switchdev.txt
+	Documentation/networking/switchdev.rst
 
 Creating an Ethernet Switch
 ===========================
Signature · 1 line
2.25.4
#37 lore raw

PATCH 34/37 docs: networking: convert tcp-thin.txt to ReST

In reply to Mauro Carvalho Chehab

Not much to be done here:

- add SPDX header;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst                      | 1 +
 Documentation/networking/ip-sysctl.rst                  | 2 +-
 Documentation/networking/{tcp-thin.txt => tcp-thin.rst} | 5 +++++
 3 files changed, 7 insertions(+), 1 deletion(-)
 rename Documentation/networking/{tcp-thin.txt => tcp-thin.rst} (97%)
Documentation/networking/index.rst +1 -0
index f53d89b5679a..89b02fbfc2eb 100644
@@ -107,6 +107,7 @@ Contents:
    strparser
    switchdev
    tc-actions-env-rules
+   tcp-thin
 
 .. only::  subproject and html
 
Documentation/networking/ip-sysctl.rst +1 -1
index 38f811d4b2f0..3266aee9e052 100644
@@ -886,7 +886,7 @@ tcp_thin_linear_timeouts - BOOLEAN
 	initiated. This improves retransmission latency for
 	non-aggressive thin streams, often found to be time-dependent.
 	For more information on thin streams, see
-	Documentation/networking/tcp-thin.txt
+	Documentation/networking/tcp-thin.rst
 
 	Default: 0
 
Documentation/networking/tcp-thin.rst renamed from Documentation/networking/tcp-thin.txt +5 -0
similarity index 97%
rename from Documentation/networking/tcp-thin.txt
rename to Documentation/networking/tcp-thin.rst
index 151e229980f1..b06765c96ea1 100644
@@ -1,5 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
 Thin-streams and TCP
 ====================
+
 A wide range of Internet-based services that use reliable transport
 protocols display what we call thin-stream properties. This means
 that the application sends data with such a low rate that the
@@ -42,6 +46,7 @@ References
 ==========
 More information on the modifications, as well as a wide range of
 experimental data can be found here:
+
 "Improving latency for interactive, thin-stream applications over
 reliable transport"
 http://simula.no/research/nd/publications/Simula.nd.477/simula_pdf_file
Signature · 1 line
2.25.4
#32 lore raw

PATCH 29/37 docs: networking: convert seg6-sysctl.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- mark code blocks and literals as such;
- add a document title;
- adjust chapters, adding proper markups;
- mark lists as such;
- add to networking/index.rst.

---
 Documentation/networking/index.rst       |  1 +
 Documentation/networking/seg6-sysctl.rst | 26 ++++++++++++++++++++++++
 Documentation/networking/seg6-sysctl.txt | 18 ----------------
 3 files changed, 27 insertions(+), 18 deletions(-)
 create mode 100644 Documentation/networking/seg6-sysctl.rst
 delete mode 100644 Documentation/networking/seg6-sysctl.txt
Documentation/networking/index.rst +1 -0
index 8b672f252f67..716744c568b7 100644
@@ -102,6 +102,7 @@ Contents:
    rxrpc
    sctp
    secid
+   seg6-sysctl
 
 .. only::  subproject and html
 
Documentation/networking/seg6-sysctl.rst new file +26 -0
new file mode 100644
index 000000000000..ec73e1445030
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+Seg6 Sysfs variables
+====================
+
+
+/proc/sys/net/conf/<iface>/seg6_* variables:
+============================================
+
+seg6_enabled - BOOL
+	Accept or drop SR-enabled IPv6 packets on this interface.
+
+	Relevant packets are those with SRH present and DA = local.
+
+	* 0 - disabled (default)
+	* not 0 - enabled
+
+seg6_require_hmac - INTEGER
+	Define HMAC policy for ingress SR-enabled packets on this interface.
+
+	* -1 - Ignore HMAC field
+	* 0 - Accept SR packets without HMAC, validate SR packets with HMAC
+	* 1 - Drop SR packets without HMAC, validate SR packets with HMAC
+
+	Default is 0.
Documentation/networking/seg6-sysctl.txt deleted +0 -18
deleted file mode 100644
index bdbde23b19cb..000000000000
@@ -1,18 +0,0 @@
-/proc/sys/net/conf/<iface>/seg6_* variables:
-
-seg6_enabled - BOOL
-	Accept or drop SR-enabled IPv6 packets on this interface.
-
-	Relevant packets are those with SRH present and DA = local.
-
-	0 - disabled (default)
-	not 0 - enabled
-
-seg6_require_hmac - INTEGER
-	Define HMAC policy for ingress SR-enabled packets on this interface.
-
-	-1 - Ignore HMAC field
-	0 - Accept SR packets without HMAC, validate SR packets with HMAC
-	1 - Drop SR packets without HMAC, validate SR packets with HMAC
-
-	Default is 0.
Signature · 1 line
2.25.4
#36 lore raw

PATCH 33/37 docs: networking: convert tc-actions-env-rules.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- use the right numbered list markup;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/tc-actions-env-rules.rst       | 29 +++++++++++++++++++
 .../networking/tc-actions-env-rules.txt       | 24 ---------------
 3 files changed, 30 insertions(+), 24 deletions(-)
 create mode 100644 Documentation/networking/tc-actions-env-rules.rst
 delete mode 100644 Documentation/networking/tc-actions-env-rules.txt
Documentation/networking/index.rst +1 -0
index 5e495804f96f..f53d89b5679a 100644
@@ -106,6 +106,7 @@ Contents:
    skfp
    strparser
    switchdev
+   tc-actions-env-rules
 
 .. only::  subproject and html
 
Documentation/networking/tc-actions-env-rules.rst new file +29 -0
new file mode 100644
index 000000000000..86884b8fb4e0
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================================
+TC Actions - Environmental Rules
+================================
+
+
+The "environmental" rules for authors of any new tc actions are:
+
+1) If you stealeth or borroweth any packet thou shalt be branching
+   from the righteous path and thou shalt cloneth.
+
+   For example if your action queues a packet to be processed later,
+   or intentionally branches by redirecting a packet, then you need to
+   clone the packet.
+
+2) If you munge any packet thou shalt call pskb_expand_head in the case
+   someone else is referencing the skb. After that you "own" the skb.
+
+3) Dropping packets you don't own is a no-no. You simply return
+   TC_ACT_SHOT to the caller and they will drop it.
+
+The "environmental" rules for callers of actions (qdiscs etc) are:
+
+#) Thou art responsible for freeing anything returned as being
+   TC_ACT_SHOT/STOLEN/QUEUED. If none of TC_ACT_SHOT/STOLEN/QUEUED is
+   returned, then all is great and you don't need to do anything.
+
+Post on netdev if something is unclear.
Documentation/networking/tc-actions-env-rules.txt deleted +0 -24
deleted file mode 100644
index f37814693ad3..000000000000
@@ -1,24 +0,0 @@
-
-The "environmental" rules for authors of any new tc actions are:
-
-1) If you stealeth or borroweth any packet thou shalt be branching
-from the righteous path and thou shalt cloneth.
-
-For example if your action queues a packet to be processed later,
-or intentionally branches by redirecting a packet, then you need to
-clone the packet.
-
-2) If you munge any packet thou shalt call pskb_expand_head in the case
-someone else is referencing the skb. After that you "own" the skb.
-
-3) Dropping packets you don't own is a no-no. You simply return
-TC_ACT_SHOT to the caller and they will drop it.
-
-The "environmental" rules for callers of actions (qdiscs etc) are:
-
-*) Thou art responsible for freeing anything returned as being
-TC_ACT_SHOT/STOLEN/QUEUED. If none of TC_ACT_SHOT/STOLEN/QUEUED is
-returned, then all is great and you don't need to do anything.
-
-Post on netdev if something is unclear.
-
Signature · 1 line
2.25.4
#40 lore raw

PATCH 37/37 docs: networking: convert tproxy.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/{tproxy.txt => tproxy.rst}     | 55 ++++++++++---------
 net/netfilter/Kconfig                         |  2 +-
 3 files changed, 32 insertions(+), 26 deletions(-)
 rename Documentation/networking/{tproxy.txt => tproxy.rst} (70%)
Documentation/networking/index.rst +1 -0
index 8f9a84b8e3f2..b423b2db5f96 100644
@@ -110,6 +110,7 @@ Contents:
    tcp-thin
    team
    timestamping
+   tproxy
 
 .. only::  subproject and html
 
Documentation/networking/tproxy.rst renamed from Documentation/networking/tproxy.txt +30 -25

92 lines not on this page · raw message

net/netfilter/Kconfig +1 -1
index 468fea1aebba..3a3915d2e1ea 100644
@@ -1043,7 +1043,7 @@ config NETFILTER_XT_TARGET_TPROXY
 	  on Netfilter connection tracking and NAT, unlike REDIRECT.
 	  For it to work you will have to configure certain iptables rules
 	  and use policy routing. For more information on how to set it up
-	  see Documentation/networking/tproxy.txt.
+	  see Documentation/networking/tproxy.rst.
 
 	  To compile it as a module, choose M here.  If unsure, say N.
 
Signature · 1 line
2.25.4
#19 lore raw

PATCH 18/37 docs: networking: convert pktgen.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- use bold markups on a few places;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../networking/{pktgen.txt => pktgen.rst}     | 316 +++++++++---------
 net/Kconfig                                   |   2 +-
 net/core/pktgen.c                             |   2 +-
 samples/pktgen/README.rst                     |   2 +-
 5 files changed, 168 insertions(+), 155 deletions(-)
 rename Documentation/networking/{pktgen.txt => pktgen.rst} (62%)
Documentation/networking/index.rst +1 -0
index e460026331c6..696181a96e3c 100644
@@ -91,6 +91,7 @@ Contents:
    operstates
    packet_mmap
    phonet
+   pktgen
 
 .. only::  subproject and html
 
Documentation/networking/pktgen.rst renamed from Documentation/networking/pktgen.txt +164 -152

474 lines not on this page · raw message

net/Kconfig +1 -1
index 8b1f85820a6b..c5ba2d180c43 100644
@@ -344,7 +344,7 @@ config NET_PKTGEN
 	  what was just said, you don't need it: say N.
 
 	  Documentation on how to use the packet generator can be found
-	  at <file:Documentation/networking/pktgen.txt>.
+	  at <file:Documentation/networking/pktgen.rst>.
 
 	  To compile this code as a module, choose M here: the
 	  module will be called pktgen.
net/core/pktgen.c +1 -1
index 08e2811b5274..b53b6d38c4df 100644
@@ -56,7 +56,7 @@
  * Integrated to 2.5.x 021029 --Lucio Maciel ([email protected])
  *
  * 021124 Finished major redesign and rewrite for new functionality.
- * See Documentation/networking/pktgen.txt for how to use this.
+ * See Documentation/networking/pktgen.rst for how to use this.
  *
  * The new operation:
  * For each CPU one thread/process is created at start. This process checks
samples/pktgen/README.rst +1 -1
index 3f6483e8b2df..f9c53ca5cf93 100644
@@ -3,7 +3,7 @@ Sample and benchmark scripts for pktgen (packet generator)
 This directory contains some pktgen sample and benchmark scripts, that
 can easily be copied and adjusted for your own use-case.
 
-General doc is located in kernel: Documentation/networking/pktgen.txt
+General doc is located in kernel: Documentation/networking/pktgen.rst
 
 Helper include files
 ====================
Signature · 1 line
2.25.4
#38 lore raw

PATCH 35/37 docs: networking: convert team.txt to ReST

In reply to Mauro Carvalho Chehab

Not much to be done here:
- add SPDX header;
- add a document title;
- add to networking/index.rst.

---
 Documentation/networking/index.rst              | 1 +
 Documentation/networking/{team.txt => team.rst} | 6 ++++++
 2 files changed, 7 insertions(+)
 rename Documentation/networking/{team.txt => team.rst} (67%)
Documentation/networking/index.rst +1 -0
index 89b02fbfc2eb..be65ee509669 100644
@@ -108,6 +108,7 @@ Contents:
    switchdev
    tc-actions-env-rules
    tcp-thin
+   team
 
 .. only::  subproject and html
 
Documentation/networking/team.rst renamed from Documentation/networking/team.txt +6 -0
similarity index 67%
rename from Documentation/networking/team.txt
rename to Documentation/networking/team.rst
index 5a013686b9ea..0a7f3a059586 100644
@@ -1,2 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====
+Team
+====
+
 Team devices are driven from userspace via libteam library which is here:
 	https://github.com/jpirko/libteam
Signature · 1 line
2.25.4
#27 lore raw

PATCH 25/37 docs: networking: convert regulatory.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{regulatory.txt => regulatory.rst}        | 29 +++++++++++--------
 MAINTAINERS                                   |  2 +-
 3 files changed, 19 insertions(+), 13 deletions(-)
 rename Documentation/networking/{regulatory.txt => regulatory.rst} (94%)
Documentation/networking/index.rst +1 -0
index e63a2cb2e4cb..bc3b04a2edde 100644
@@ -98,6 +98,7 @@ Contents:
    radiotap-headers
    ray_cs
    rds
+   regulatory
 
 .. only::  subproject and html
 
Documentation/networking/regulatory.rst renamed from Documentation/networking/regulatory.txt +17 -12
similarity index 94%
rename from Documentation/networking/regulatory.txt
rename to Documentation/networking/regulatory.rst
index 381e5b23d61d..8701b91e81ee 100644
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================================
 Linux wireless regulatory documentation
----------------------------------------
+=======================================
 
 This document gives a brief review over how the Linux wireless
 regulatory infrastructure works.
@@ -57,7 +60,7 @@ Users can use iw:
 
 http://wireless.kernel.org/en/users/Documentation/iw
 
-An example:
+An example::
 
   # set regulatory domain to "Costa Rica"
   iw reg set CR
@@ -104,9 +107,9 @@ Example code - drivers hinting an alpha2:
 
 This example comes from the zd1211rw device driver. You can start
 by having a mapping of your device's EEPROM country/regulatory
-domain value to a specific alpha2 as follows:
+domain value to a specific alpha2 as follows::
 
-static struct zd_reg_alpha2_map reg_alpha2_map[] = {
+  static struct zd_reg_alpha2_map reg_alpha2_map[] = {
 	{ ZD_REGDOMAIN_FCC, "US" },
 	{ ZD_REGDOMAIN_IC, "CA" },
 	{ ZD_REGDOMAIN_ETSI, "DE" }, /* Generic ETSI, use most restrictive */
@@ -116,10 +119,10 @@ static struct zd_reg_alpha2_map reg_alpha2_map[] = {
 	{ ZD_REGDOMAIN_FRANCE, "FR" },
 
 Then you can define a routine to map your read EEPROM value to an alpha2,
-as follows:
+as follows::
 
-static int zd_reg2alpha2(u8 regdomain, char *alpha2)
-{
+  static int zd_reg2alpha2(u8 regdomain, char *alpha2)
+  {
 	unsigned int i;
 	struct zd_reg_alpha2_map *reg_map;
 		for (i = 0; i < ARRAY_SIZE(reg_alpha2_map); i++) {
@@ -131,12 +134,14 @@ static int zd_reg2alpha2(u8 regdomain, char *alpha2)
 		}
 	}
 	return 1;
-}
+  }
 
 Lastly, you can then hint to the core of your discovered alpha2, if a match
 was found. You need to do this after you have registered your wiphy. You
 are expected to do this during initialization.
 
+::
+
 	r = zd_reg2alpha2(mac->regdomain, alpha2);
 	if (!r)
 		regulatory_hint(hw->wiphy, alpha2);
@@ -156,9 +161,9 @@ call regulatory_hint() with the regulatory domain structure in it.
 Bellow is a simple example, with a regulatory domain cached using the stack.
 Your implementation may vary (read EEPROM cache instead, for example).
 
-Example cache of some regulatory domain
+Example cache of some regulatory domain::
 
-struct ieee80211_regdomain mydriver_jp_regdom = {
+  struct ieee80211_regdomain mydriver_jp_regdom = {
 	.n_reg_rules = 3,
 	.alpha2 =  "JP",
 	//.alpha2 =  "99", /* If I have no alpha2 to map it to */
@@ -173,9 +178,9 @@ struct ieee80211_regdomain mydriver_jp_regdom = {
 			NL80211_RRF_NO_IR|
 			NL80211_RRF_DFS),
 	}
-};
+  };
 
-Then in some part of your code after your wiphy has been registered:
+Then in some part of your code after your wiphy has been registered::
 
 	struct ieee80211_regdomain *rd;
 	int size_of_regd;
MAINTAINERS +1 -1
index d525b85a37a0..caab14c5c12b 100644
@@ -193,7 +193,7 @@ W:	https://wireless.wiki.kernel.org/
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git
 F:	Documentation/driver-api/80211/cfg80211.rst
-F:	Documentation/networking/regulatory.txt
+F:	Documentation/networking/regulatory.rst
 F:	include/linux/ieee80211.h
 F:	include/net/cfg80211.h
 F:	include/net/ieee80211_radiotap.h
Signature · 1 line
2.25.4
#24 lore raw

PATCH 23/37 docs: networking: convert ray_cs.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- use copyright symbol;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../networking/{ray_cs.txt => ray_cs.rst}     | 101 ++++++++++--------
 drivers/net/wireless/Kconfig                  |   2 +-
 3 files changed, 60 insertions(+), 44 deletions(-)
 rename Documentation/networking/{ray_cs.txt => ray_cs.rst} (65%)
Documentation/networking/index.rst +1 -0
index 85bc52d0b3a6..b7e35b0d905c 100644
@@ -96,6 +96,7 @@ Contents:
    ppp_generic
    proc_net_tcp
    radiotap-headers
+   ray_cs
 
 .. only::  subproject and html
 
Documentation/networking/ray_cs.rst renamed from Documentation/networking/ray_cs.txt +58 -43

170 lines not on this page · raw message

drivers/net/wireless/Kconfig +1 -1
index 1c98d781ae49..15b0ad171f4c 100644
@@ -57,7 +57,7 @@ config PCMCIA_RAYCS
 	---help---
 	  Say Y here if you intend to attach an Aviator/Raytheon PCMCIA
 	  (PC-card) wireless Ethernet networking card to your computer.
-	  Please read the file <file:Documentation/networking/ray_cs.txt> for
+	  Please read the file <file:Documentation/networking/ray_cs.rst> for
 	  details.
 
 	  To compile this driver as a module, choose M here: the module will be
Signature · 1 line
2.25.4
#21 lore raw

PATCH 20/37 docs: networking: convert ppp_generic.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{ppp_generic.txt => ppp_generic.rst}      | 52 ++++++++++++-------
 2 files changed, 33 insertions(+), 20 deletions(-)
 rename Documentation/networking/{ppp_generic.txt => ppp_generic.rst} (91%)
Documentation/networking/index.rst +1 -0
index 18bb10239cad..f89535871481 100644
@@ -93,6 +93,7 @@ Contents:
    phonet
    pktgen
    plip
+   ppp_generic
 
 .. only::  subproject and html
 
Documentation/networking/ppp_generic.rst renamed from Documentation/networking/ppp_generic.txt +32 -20

145 lines not on this page · raw message

Signature · 1 line
2.25.4
#34 lore raw

PATCH 31/37 docs: networking: convert strparser.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{strparser.txt => strparser.rst}          | 85 +++++++++++++------
 2 files changed, 60 insertions(+), 26 deletions(-)
 rename Documentation/networking/{strparser.txt => strparser.rst} (80%)
Documentation/networking/index.rst +1 -0
index d19ddcbe66e5..e5a705024c6a 100644
@@ -104,6 +104,7 @@ Contents:
    secid
    seg6-sysctl
    skfp
+   strparser
 
 .. only::  subproject and html
 
Documentation/networking/strparser.rst renamed from Documentation/networking/strparser.txt +59 -26

176 lines not on this page · raw message

Signature · 1 line
2.25.4
#3 lore raw

PATCH 3/37 docs: networking: convert ltpc.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/{ltpc.txt => ltpc.rst}         | 45 ++++++++++++-------
 drivers/net/appletalk/Kconfig                 |  2 +-
 3 files changed, 31 insertions(+), 17 deletions(-)
 rename Documentation/networking/{ltpc.txt => ltpc.rst} (86%)
Documentation/networking/index.rst +1 -0
index acd2567cf0d4..b3608b177a8b 100644
@@ -76,6 +76,7 @@ Contents:
    kcm
    l2tp
    lapb-module
+   ltpc
 
 .. only::  subproject and html
 
Documentation/networking/ltpc.rst renamed from Documentation/networking/ltpc.txt +29 -16

119 lines not on this page · raw message

drivers/net/appletalk/Kconfig +1 -1
index ccde6479050c..10589a82263b 100644
@@ -48,7 +48,7 @@ config LTPC
 	  If you are in doubt, this card is the one with the 65C02 chip on it.
 	  You also need version 1.3.3 or later of the netatalk package.
 	  This driver is experimental, which means that it may not work.
-	  See the file <file:Documentation/networking/ltpc.txt>.
+	  See the file <file:Documentation/networking/ltpc.rst>.
 
 config COPS
 	tristate "COPS LocalTalk PC support"
Signature · 1 line
2.25.4
#15 lore raw

PATCH 15/37 docs: networking: convert operstates.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- adjust chapters, adding proper markups;
- mark lists as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{operstates.txt => operstates.rst}        | 45 ++++++++++++++-----
 2 files changed, 34 insertions(+), 12 deletions(-)
 rename Documentation/networking/{operstates.txt => operstates.rst} (87%)
Documentation/networking/index.rst +1 -0
index b7f558480aca..028a36821b9a 100644
@@ -88,6 +88,7 @@ Contents:
    nf_conntrack-sysctl
    nf_flowtable
    openvswitch
+   operstates
 
 .. only::  subproject and html
 
Documentation/networking/operstates.rst renamed from Documentation/networking/operstates.txt +33 -12

116 lines not on this page · raw message

Signature · 1 line
2.25.4
#20 lore raw

PATCH 19/37 docs: networking: convert PLIP.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../networking/{PLIP.txt => plip.rst}         | 43 +++++++++++--------
 drivers/net/plip/Kconfig                      |  2 +-
 3 files changed, 27 insertions(+), 19 deletions(-)
 rename Documentation/networking/{PLIP.txt => plip.rst} (92%)
Documentation/networking/index.rst +1 -0
index 696181a96e3c..18bb10239cad 100644
@@ -92,6 +92,7 @@ Contents:
    packet_mmap
    phonet
    pktgen
+   plip
 
 .. only::  subproject and html
 
Documentation/networking/plip.rst renamed from Documentation/networking/PLIP.txt +25 -18

105 lines not on this page · raw message

drivers/net/plip/Kconfig +1 -1
index b41035be2d51..e03556d1d0c2 100644
@@ -21,7 +21,7 @@ config PLIP
 	  bits at a time (mode 0) or with special PLIP cables, to be used on
 	  bidirectional parallel ports only, which can transmit 8 bits at a
 	  time (mode 1); you can find the wiring of these cables in
-	  <file:Documentation/networking/PLIP.txt>.  The cables can be up to
+	  <file:Documentation/networking/plip.rst>.  The cables can be up to
 	  15m long.  Mode 0 works also if one of the machines runs DOS/Windows
 	  and has some PLIP software installed, e.g. the Crynwr PLIP packet
 	  driver (<http://oak.oakland.edu/simtel.net/msdos/pktdrvr-pre.html>)
Signature · 1 line
2.25.4
#7 lore raw

PATCH 7/37 docs: networking: convert netconsole.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- add notes markups;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 .../admin-guide/kernel-parameters.txt         |   2 +-
 Documentation/admin-guide/serial-console.rst  |   2 +-
 Documentation/networking/index.rst            |   1 +
 .../{netconsole.txt => netconsole.rst}        | 125 +++++++++++-------
 drivers/net/Kconfig                           |   4 +-
 drivers/net/ethernet/toshiba/ps3_gelic_net.c  |   2 +-
 drivers/net/ethernet/toshiba/spider_net.c     |   2 +-
 7 files changed, 84 insertions(+), 54 deletions(-)
 rename Documentation/networking/{netconsole.txt => netconsole.rst} (66%)
Documentation/admin-guide/kernel-parameters.txt +1 -1
index 25644daa36ea..5a44c1bf85e7 100644
@@ -638,7 +638,7 @@
 
 			See Documentation/admin-guide/serial-console.rst for more
 			information.  See
-			Documentation/networking/netconsole.txt for an
+			Documentation/networking/netconsole.rst for an
 			alternative.
 
 		uart[8250],io,<addr>[,options]
Documentation/admin-guide/serial-console.rst +1 -1
index a8d1e36b627a..58b32832e50a 100644
@@ -54,7 +54,7 @@ You will need to create a new device to use ``/dev/console``. The official
 ``/dev/console`` is now character device 5,1.
 
 (You can also use a network device as a console.  See
-``Documentation/networking/netconsole.txt`` for information on that.)
+``Documentation/networking/netconsole.rst`` for information on that.)
 
 Here's an example that will use ``/dev/ttyS1`` (COM2) as the console.
 Replace the sample values as needed.
Documentation/networking/index.rst +1 -0
index 492658bf7c0d..e58f872d401d 100644
@@ -80,6 +80,7 @@ Contents:
    mac80211-injection
    mpls-sysctl
    multiqueue
+   netconsole
 
 .. only::  subproject and html
 
Documentation/networking/netconsole.rst renamed from Documentation/networking/netconsole.txt +77 -48

226 lines not on this page · raw message

drivers/net/Kconfig +2 -2
index c822f4a6d166..ad64be98330f 100644
@@ -302,7 +302,7 @@ config NETCONSOLE
 	tristate "Network console logging support"
 	---help---
 	  If you want to log kernel messages over the network, enable this.
-	  See <file:Documentation/networking/netconsole.txt> for details.
+	  See <file:Documentation/networking/netconsole.rst> for details.
 
 config NETCONSOLE_DYNAMIC
 	bool "Dynamic reconfiguration of logging targets"
@@ -312,7 +312,7 @@ config NETCONSOLE_DYNAMIC
 	  This option enables the ability to dynamically reconfigure target
 	  parameters (interface, IP addresses, port numbers, MAC addresses)
 	  at runtime through a userspace interface exported using configfs.
-	  See <file:Documentation/networking/netconsole.txt> for details.
+	  See <file:Documentation/networking/netconsole.rst> for details.
 
 config NETPOLL
 	def_bool NETCONSOLE
drivers/net/ethernet/toshiba/ps3_gelic_net.c +1 -1
index 070dd6fa9401..310e6839c6e5 100644
@@ -1150,7 +1150,7 @@ static irqreturn_t gelic_card_interrupt(int irq, void *ptr)
  * gelic_net_poll_controller - artificial interrupt for netconsole etc.
  * @netdev: interface device structure
  *
- * see Documentation/networking/netconsole.txt
+ * see Documentation/networking/netconsole.rst
  */
 void gelic_net_poll_controller(struct net_device *netdev)
 {
drivers/net/ethernet/toshiba/spider_net.c +1 -1
index 6576271642c1..3902b3aeb0c2 100644
@@ -1615,7 +1615,7 @@ spider_net_interrupt(int irq, void *ptr)
  * spider_net_poll_controller - artificial interrupt for netconsole etc.
  * @netdev: interface device structure
  *
- * see Documentation/networking/netconsole.txt
+ * see Documentation/networking/netconsole.rst
  */
 static void
 spider_net_poll_controller(struct net_device *netdev)
Signature · 1 line
2.25.4
#17 lore raw

PATCH 17/37 docs: networking: convert phonet.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title markup;
- use copyright symbol;
- add notes markups;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 Documentation/networking/packet_mmap.rst      |  2 +-
 .../networking/{phonet.txt => phonet.rst}     | 56 ++++++++++++-------
 MAINTAINERS                                   |  2 +-
 4 files changed, 39 insertions(+), 22 deletions(-)
 rename Documentation/networking/{phonet.txt => phonet.rst} (82%)
Documentation/networking/index.rst +1 -0
index 8262b535a83e..e460026331c6 100644
@@ -90,6 +90,7 @@ Contents:
    openvswitch
    operstates
    packet_mmap
+   phonet
 
 .. only::  subproject and html
 
Documentation/networking/packet_mmap.rst +1 -1
index 5f213d17652f..884c7222b9e9 100644
@@ -1076,7 +1076,7 @@ Miscellaneous bits
 ==================
 
 - Packet sockets work well together with Linux socket filters, thus you also
-  might want to have a look at Documentation/networking/filter.txt
+  might want to have a look at Documentation/networking/filter.rst
 
 THANKS
 ======
Documentation/networking/phonet.rst renamed from Documentation/networking/phonet.txt +36 -20

130 lines not on this page · raw message

MAINTAINERS +1 -1
index 1546ecb855b5..0d2005e8380e 100644
@@ -13297,7 +13297,7 @@ F:	drivers/input/joystick/pxrc.c
 PHONET PROTOCOL
 M:	Remi Denis-Courmont <[email protected]>
 S:	Supported
-F:	Documentation/networking/phonet.txt
+F:	Documentation/networking/phonet.rst
 F:	include/linux/phonet.h
 F:	include/net/phonet/
 F:	include/uapi/linux/phonet.h
Signature · 1 line
2.25.4
#22 lore raw

PATCH 21/37 docs: networking: convert proc_net_tcp.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 .../{proc_net_tcp.txt => proc_net_tcp.rst}    | 23 +++++++++++++------
 2 files changed, 17 insertions(+), 7 deletions(-)
 rename Documentation/networking/{proc_net_tcp.txt => proc_net_tcp.rst} (83%)
Documentation/networking/index.rst +1 -0
index f89535871481..0da7eb0ec85a 100644
@@ -94,6 +94,7 @@ Contents:
    pktgen
    plip
    ppp_generic
+   proc_net_tcp
 
 .. only::  subproject and html
 
Documentation/networking/proc_net_tcp.rst renamed from Documentation/networking/proc_net_tcp.txt +16 -7
similarity index 83%
rename from Documentation/networking/proc_net_tcp.txt
rename to Documentation/networking/proc_net_tcp.rst
index 4a79209e77a7..7d9dfe36af45 100644
@@ -1,15 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============================================
+The proc/net/tcp and proc/net/tcp6 variables
+============================================
+
 This document describes the interfaces /proc/net/tcp and /proc/net/tcp6.
 Note that these interfaces are deprecated in favor of tcp_diag.
 
-These /proc interfaces provide information about currently active TCP 
+These /proc interfaces provide information about currently active TCP
 connections, and are implemented by tcp4_seq_show() in net/ipv4/tcp_ipv4.c
 and tcp6_seq_show() in net/ipv6/tcp_ipv6.c, respectively.
 
 It will first list all listening TCP sockets, and next list all established
-TCP connections. A typical entry of /proc/net/tcp would look like this (split 
-up into 3 parts because of the length of the line):
+TCP connections. A typical entry of /proc/net/tcp would look like this (split
+up into 3 parts because of the length of the line)::
 
-   46: 010310AC:9C4C 030310AC:1770 01 
+   46: 010310AC:9C4C 030310AC:1770 01
    |      |      |      |      |   |--> connection state
    |      |      |      |      |------> remote TCP port number
    |      |      |      |-------------> remote IPv4 address
@@ -17,7 +23,7 @@ up into 3 parts because of the length of the line):
    |      |---------------------------> local IPv4 address
    |----------------------------------> number of entry
 
-   00000150:00000000 01:00000019 00000000  
+   00000150:00000000 01:00000019 00000000
       |        |     |     |       |--> number of unrecovered RTO timeouts
       |        |     |     |----------> number of jiffies until timer expires
       |        |     |----------------> timer_active (see below)
@@ -25,7 +31,7 @@ up into 3 parts because of the length of the line):
       |-------------------------------> transmit-queue
 
    1000        0 54165785 4 cd1e6040 25 4 27 3 -1
-    |          |    |     |    |     |  | |  | |--> slow start size threshold, 
+    |          |    |     |    |     |  | |  | |--> slow start size threshold,
     |          |    |     |    |     |  | |  |      or -1 if the threshold
     |          |    |     |    |     |  | |  |      is >= 0xFFFF
     |          |    |     |    |     |  | |  |----> sending congestion window
@@ -40,9 +46,12 @@ up into 3 parts because of the length of the line):
     |---------------------------------------------> uid
 
 timer_active:
+
+ ==  ================================================================
   0  no timer is pending
   1  retransmit-timer is pending
   2  another timer (e.g. delayed ack or keepalive) is pending
-  3  this is a socket in TIME_WAIT state. Not all fields will contain 
+  3  this is a socket in TIME_WAIT state. Not all fields will contain
      data (or even exist)
   4  zero window probe timer is pending
+ ==  ================================================================
Signature · 1 line
2.25.4
#12 lore raw

PATCH 12/37 docs: networking: convert nf_conntrack-sysctl.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark lists as such;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |  1 +
 ...ack-sysctl.txt => nf_conntrack-sysctl.rst} | 51 +++++++++++--------
 2 files changed, 30 insertions(+), 22 deletions(-)
 rename Documentation/networking/{nf_conntrack-sysctl.txt => nf_conntrack-sysctl.rst} (85%)
Documentation/networking/index.rst +1 -0
index d98509f15363..e5128bb7e7df 100644
@@ -85,6 +85,7 @@ Contents:
    netdevices
    netfilter-sysctl
    netif-msg
+   nf_conntrack-sysctl
 
 .. only::  subproject and html
 
Documentation/networking/nf_conntrack-sysctl.rst renamed from Documentation/networking/nf_conntrack-sysctl.txt +29 -22

98 lines not on this page · raw message

Signature · 1 line
2.25.4
#11 lore raw

PATCH 11/37 docs: networking: convert netif-msg.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust title and chapter markups;
- mark lists as such;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst     |  1 +
 Documentation/networking/netif-msg.rst | 95 ++++++++++++++++++++++++++
 Documentation/networking/netif-msg.txt | 79 ---------------------
 3 files changed, 96 insertions(+), 79 deletions(-)
 create mode 100644 Documentation/networking/netif-msg.rst
 delete mode 100644 Documentation/networking/netif-msg.txt
Documentation/networking/index.rst +1 -0
index 1ae0cbef8c04..d98509f15363 100644
@@ -84,6 +84,7 @@ Contents:
    netdev-features
    netdevices
    netfilter-sysctl
+   netif-msg
 
 .. only::  subproject and html
 
Documentation/networking/netif-msg.rst new file +95 -0

95 lines not on this page · raw message

Documentation/networking/netif-msg.txt deleted +0 -79

79 lines not on this page · raw message

Signature · 1 line
2.25.4
#8 lore raw

PATCH 8/37 docs: networking: convert netdev-features.txt to ReST

In reply to Mauro Carvalho Chehab

Not much to be done here:

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- add to networking/index.rst.

---
 .../networking/checksum-offloads.rst          |  2 +-
 Documentation/networking/index.rst            |  1 +
 ...etdev-features.txt => netdev-features.rst} | 19 +++++++++++--------
 include/linux/netdev_features.h               |  2 +-
 4 files changed, 14 insertions(+), 10 deletions(-)
 rename Documentation/networking/{netdev-features.txt => netdev-features.rst} (95%)
Documentation/networking/checksum-offloads.rst +1 -1
index 905c8a84b103..69b23cf6879e 100644
@@ -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
index e58f872d401d..4c6aa3db97d4 100644
@@ -81,6 +81,7 @@ Contents:
    mpls-sysctl
    multiqueue
    netconsole
+   netdev-features
 
 .. only::  subproject and html
 
Documentation/networking/netdev-features.rst renamed from Documentation/networking/netdev-features.txt +11 -8
similarity index 95%
rename from Documentation/networking/netdev-features.txt
rename to Documentation/networking/netdev-features.rst
index 58dd1c1e3c65..a2d7d7160e39 100644
@@ -1,3 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================================================
 Netdev features mess and how to get out from it alive
 =====================================================
 
@@ -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
 verbatim.  Today's devices add multiple features and bugs (read: offloads)
@@ -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
 is calculated and filtered by calling 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:
 
@@ -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.
 This section describes semantics of some of them.
include/linux/netdev_features.h +1 -1
index 9d53c5ad272c..2cc3cf80b49a 100644
@@ -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
Signature · 1 line
2.25.4
#10 lore raw

PATCH 10/37 docs: networking: convert netfilter-sysctl.txt to ReST

In reply to Mauro Carvalho Chehab

Not much to be done here:

- add SPDX header;
- add a document title;
- add a chapter markup;
- mark tables as such;
- add to networking/index.rst.

---
 Documentation/networking/index.rst                    |  1 +
 .../{netfilter-sysctl.txt => netfilter-sysctl.rst}    | 11 +++++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)
 rename Documentation/networking/{netfilter-sysctl.txt => netfilter-sysctl.rst} (62%)
Documentation/networking/index.rst +1 -0
index 5a320553ffba..1ae0cbef8c04 100644
@@ -83,6 +83,7 @@ Contents:
    netconsole
    netdev-features
    netdevices
+   netfilter-sysctl
 
 .. only::  subproject and html
 
Documentation/networking/netfilter-sysctl.rst renamed from Documentation/networking/netfilter-sysctl.txt +9 -2
similarity index 62%
rename from Documentation/networking/netfilter-sysctl.txt
rename to Documentation/networking/netfilter-sysctl.rst
index 55791e50e169..beb6d7b275d4 100644
@@ -1,8 +1,15 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================
+Netfilter Sysfs variables
+=========================
+
 /proc/sys/net/netfilter/* Variables:
+====================================
 
 nf_log_all_netns - BOOLEAN
-	0 - disabled (default)
-	not 0 - enabled
+	- 0 - disabled (default)
+	- not 0 - enabled
 
 	By default, only init_net namespace can log packets into kernel log
 	with LOG target; this aims to prevent containers from flooding host
Signature · 1 line
2.25.4
#6 lore raw

PATCH 6/37 docs: networking: convert multiqueue.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- mark code blocks and literals as such;
- use :field: markup;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/bonding.rst          |  2 +-
 Documentation/networking/index.rst            |  1 +
 .../{multiqueue.txt => multiqueue.rst}        | 41 +++++++++----------
 3 files changed, 22 insertions(+), 22 deletions(-)
 rename Documentation/networking/{multiqueue.txt => multiqueue.rst} (76%)
Documentation/networking/bonding.rst +1 -1
index dd49f95d28d3..24168b0d16bd 100644
@@ -1639,7 +1639,7 @@ can safely be sent over either interface.  Such configurations may be achieved
 using the traffic control utilities inherent in linux.
 
 By default the bonding driver is multiqueue aware and 16 queues are created
-when the driver initializes (see Documentation/networking/multiqueue.txt
+when the driver initializes (see Documentation/networking/multiqueue.rst
 for details).  If more or less queues are desired the module parameter
 tx_queues can be used to change this value.  There is no sysfs parameter
 available as the allocation is done at module init time.
Documentation/networking/index.rst +1 -0
index a751cda83c3d..492658bf7c0d 100644
@@ -79,6 +79,7 @@ Contents:
    ltpc
    mac80211-injection
    mpls-sysctl
+   multiqueue
 
 .. only::  subproject and html
 
Documentation/networking/multiqueue.rst renamed from Documentation/networking/multiqueue.txt +20 -21

78 lines not on this page · raw message

Signature · 1 line
2.25.4
#1 lore raw

PATCH 1/37 docs: networking: convert l2tp.txt to ReST

In reply to Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

---
 Documentation/networking/index.rst            |   1 +
 .../networking/{l2tp.txt => l2tp.rst}         | 145 ++++++++++--------
 2 files changed, 80 insertions(+), 66 deletions(-)
 rename Documentation/networking/{l2tp.txt => l2tp.rst} (79%)
Documentation/networking/index.rst +1 -0
index e1ff08b94d90..0c5d7a037983 100644
@@ -74,6 +74,7 @@ Contents:
    ipvlan
    ipvs-sysctl
    kcm
+   l2tp
 
 .. only::  subproject and html
 
Documentation/networking/l2tp.rst renamed from Documentation/networking/l2tp.txt +79 -66

205 lines not on this page · raw message

Signature · 1 line
2.25.4
Acked-by on v1 24/37
#26 lore raw

Re: [PATCH 24/37] docs: networking: convert rds.txt to ReST

In reply to Mauro Carvalho Chehab
Quoted 10 lines · Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- mark lists as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

---

maintainer Acked-by on v1 27/37
#30 lore raw

Re: [PATCH 27/37] docs: networking: convert sctp.txt to ReST

In reply to Mauro Carvalho Chehab
Quoted 6 lines · Mauro Carvalho Chehab

- add SPDX header;
- add a document title;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

Quoted 97 lines
---
 Documentation/networking/index.rst            |  1 +
 .../networking/{sctp.txt => sctp.rst}         | 37 +++++++++++--------
 MAINTAINERS                                   |  2 +-
 3 files changed, 24 insertions(+), 16 deletions(-)
 rename Documentation/networking/{sctp.txt => sctp.rst} (64%)
Documentation/networking/index.rst +1 -0
index cd307b9601fa..1761eb715061 100644
@@ -100,6 +100,7 @@ Contents:
    rds
    regulatory
    rxrpc
+   sctp
 
 .. only::  subproject and html
 
Documentation/networking/sctp.rst renamed from Documentation/networking/sctp.txt +21 -15
similarity index 64%
rename from Documentation/networking/sctp.txt
rename to Documentation/networking/sctp.rst
index 97b810ca9082..9f4d9c8a925b 100644
@@ -1,35 +1,42 @@
-Linux Kernel SCTP 
+.. SPDX-License-Identifier: GPL-2.0
+
+========> +Linux Kernel SCTP
+========>  
 This is the current BETA release of the Linux Kernel SCTP reference
-implementation.  
+implementation.
 
 SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
 reliable transport protocol, with congestion control, support for
 transparent multi-homing, and multiple ordered streams of messages.
 RFC2960 defines the core protocol.  The IETF SIGTRAN working group originally
-developed the SCTP protocol and later handed the protocol over to the 
-Transport Area (TSVWG) working group for the continued evolvement of SCTP as a 
-general purpose transport.  
+developed the SCTP protocol and later handed the protocol over to the
+Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
+general purpose transport.
 
-See the IETF website (http://www.ietf.org) for further documents on SCTP. 
-See http://www.ietf.org/rfc/rfc2960.txt 
+See the IETF website (http://www.ietf.org) for further documents on SCTP.
+See http://www.ietf.org/rfc/rfc2960.txt
 
 The initial project goal is to create an Linux kernel reference implementation
-of SCTP that is RFC 2960 compliant and provides an programming interface 
-referred to as the  UDP-style API of the Sockets Extensions for SCTP, as 
-proposed in IETF Internet-Drafts.    
+of SCTP that is RFC 2960 compliant and provides an programming interface
+referred to as the  UDP-style API of the Sockets Extensions for SCTP, as
+proposed in IETF Internet-Drafts.
 
-Caveats:  
+Caveats
+===>  
--lksctp can be built as statically or as a module.  However, be aware that 
-module removal of lksctp is not yet a safe activity.   
+- lksctp can be built as statically or as a module.  However, be aware that
+  module removal of lksctp is not yet a safe activity.
 
--There is tentative support for IPv6, but most work has gone towards 
-implementation and testing lksctp on IPv4.   
+- There is tentative support for IPv6, but most work has gone towards
+  implementation and testing lksctp on IPv4.
 
 
 For more information, please visit the lksctp project website:
+
    http://www.sf.net/projects/lksctp
 
 Or contact the lksctp developers through the mailing list:
+
    <[email protected]>
MAINTAINERS +1 -1
index 93e1b253ae51..64789b29c085 100644
@@ -15044,7 +15044,7 @@ M:	Marcelo Ricardo Leitner <[email protected]>
 L:	[email protected]
 S:	Maintained
 W:	http://lksctp.sourceforge.net
-F:	Documentation/networking/sctp.txt
+F:	Documentation/networking/sctp.rst
 F:	include/linux/sctp.h
 F:	include/net/sctp/
 F:	include/uapi/linux/sctp.h
Signature · 1 line
2.25.4
maintainer
#41 lore raw
In reply to Mauro Carvalho Chehab

From: Mauro Carvalho Chehab <[email protected]>
Date: Thu, 30 Apr 2020 18:03:55 +0200

Quoted 5 lines

That's the second part of my work to convert the networking text files into ReST. it is based on today's linux-next (next-20200430).

The full series (including those ones) are at:

Quoted 8 lines

https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs

I should be sending the remaining patches (another /38 series) after getting those merged at -next.

The documents, converted to HTML via the building system are at:

https://www.infradead.org/~mchehab/kernel_docs/networking/

Series applied to net-next, thank you.