Skip to contentSkip to conversation

docs: net: Convert tcp.txt to RST format

PATCH RESEND In review Tobin C. Harding 2 participants 3 messages Sep 11, 2018

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

PATCH RESEND 1/1 docs: net: Convert tcp.txt to RST format

Restructured text is the kernel documentation format of choice now. Some text from tcp.txt is out of date, specifically the function tcp_write() does not appear to be in the tree anymore. Also the following data members have been removed

	  sk->tcp_pend_event
	  sk->transmit_queue
	  sk->transmit_new
	  sk->transmit_end
	  sk->tcp_last_tx_ack
	  sk->tcp_dup_ack

Remove section 'How the new TCP output machine [nyi] works'. This leaves only a single section so we can name the document with that section heading now.

Convert tcp.txt to RST format. Add GPLv2 SPDX tag.

---

This is v1 re-sending since I sent the original during the merge window :(

CC'd Eric as maintainer of TCP (according to MAINTAINERS)

I was going to ask a question on netdev list as to whether this file was out of date. I just removed the suspect section and did the patch instead. I am not sure if it is correct to remove it or if the structure documented has just been changed. Please see bottom section of removed text ('How the new TCP output machine [nyi] works').

Also please note this file is not covered by MAINTAINERS, should it be?

thanks,
Tobin.

 Documentation/networking/00-INDEX  |   2 -
 Documentation/networking/index.rst |   1 +
 Documentation/networking/tcp.rst   |  71 ++++++++++++++++++++
 Documentation/networking/tcp.txt   | 101 -----------------------------
 4 files changed, 72 insertions(+), 103 deletions(-)
 create mode 100644 Documentation/networking/tcp.rst
 delete mode 100644 Documentation/networking/tcp.txt
Documentation/networking/00-INDEX +0 -2
index 02a323c43261..dcbccae4043e 100644
@@ -198,8 +198,6 @@ tc-actions-env-rules.txt
 	- rules for traffic control (tc) actions.
 timestamping.txt
 	- overview of network packet timestamping variants.
-tcp.txt
-	- short blurb on how TCP output takes place.
 tcp-thin.txt
 	- kernel tuning options for low rate 'thin' TCP streams.
 team.txt
Documentation/networking/index.rst +1 -0
index fcd710f2cc7a..1cb9bcc36dd7 100644
@@ -21,6 +21,7 @@ Contents:
    net_failover
    alias
    bridge
+   tcp
 
 .. only::  subproject
 
Documentation/networking/tcp.rst new file +71 -0

71 lines not on this page · raw message

Documentation/networking/tcp.txt deleted +0 -101

101 lines not on this page · raw message

Signature · 1 line
2.17.1
#1 lore raw
Quoted 12 lines · Tobin C. Harding

Restructured text is the kernel documentation format of choice now. Some text from tcp.txt is out of date, specifically the function tcp_write() does not appear to be in the tree anymore. Also the following data members have been removed

	  sk->tcp_pend_event
	  sk->transmit_queue
	  sk->transmit_new
	  sk->transmit_end
	  sk->tcp_last_tx_ack
	  sk->tcp_dup_ack
Quoted 8 lines

Remove section 'How the new TCP output machine [nyi] works'. This leaves only a single section so we can name the document with that section heading now.

Convert tcp.txt to RST format. Add GPLv2 SPDX tag.

I dunno, this 'doc' is probably useless and should be deleted.

#2 lore raw
Quoted 19 lines · Eric Dumazet
Quoted 16 lines · Tobin C. Harding

Restructured text is the kernel documentation format of choice now. Some text from tcp.txt is out of date, specifically the function tcp_write() does not appear to be in the tree anymore. Also the following data members have been removed

	  sk->tcp_pend_event
	  sk->transmit_queue
	  sk->transmit_new
	  sk->transmit_end
	  sk->tcp_last_tx_ack
	  sk->tcp_dup_ack

Remove section 'How the new TCP output machine [nyi] works'. This leaves only a single section so we can name the document with that section heading now.

Quoted 6 lines
Quoted 4 lines

Convert tcp.txt to RST format. Add GPLv2 SPDX tag.

I dunno, this 'doc' is probably useless and should be deleted.

Cool! The best type of patch - line removal only. I'll put it in.

thanks,
Tobin.