From 671d114d8cde3ba4390714b850c86d8b39d31009 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 30 Apr 2020 18:04:22 +0200 Subject: docs: networking: convert sctp.txt to ReST - add SPDX header; - add a document title; - adjust identation, whitespaces and blank lines where needed; - add to networking/index.rst. Signed-off-by: Mauro Carvalho Chehab Acked-by: Marcelo Ricardo Leitner Signed-off-by: David S. Miller --- Documentation/networking/index.rst | 1 + Documentation/networking/sctp.rst | 42 ++++++++++++++++++++++++++++++++++++++ Documentation/networking/sctp.txt | 35 ------------------------------- MAINTAINERS | 2 +- 4 files changed, 44 insertions(+), 36 deletions(-) create mode 100644 Documentation/networking/sctp.rst delete mode 100644 Documentation/networking/sctp.txt diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index cd307b9601fa..1761eb715061 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -100,6 +100,7 @@ Contents: rds regulatory rxrpc + sctp .. only:: subproject and html diff --git a/Documentation/networking/sctp.rst b/Documentation/networking/sctp.rst new file mode 100644 index 000000000000..9f4d9c8a925b --- /dev/null +++ b/Documentation/networking/sctp.rst @@ -0,0 +1,42 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================= +Linux Kernel SCTP +================= + +This is the current BETA release of the Linux Kernel SCTP reference +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. + +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. + +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. + +- 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: + + diff --git a/Documentation/networking/sctp.txt b/Documentation/networking/sctp.txt deleted file mode 100644 index 97b810ca9082..000000000000 --- a/Documentation/networking/sctp.txt +++ /dev/null @@ -1,35 +0,0 @@ -Linux Kernel SCTP - -This is the current BETA release of the Linux Kernel SCTP reference -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. - -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. - -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. - --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: - diff --git a/MAINTAINERS b/MAINTAINERS index 866a0dcd66ef..0ac9cec0bce6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -14999,7 +14999,7 @@ M: Marcelo Ricardo Leitner L: linux-sctp@vger.kernel.org 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 -- cgit v1.2.3