Commit 671d114d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarMarcelo Ricardo Leitner <marcelo.leitner@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 9f72374c
...@@ -100,6 +100,7 @@ Contents: ...@@ -100,6 +100,7 @@ Contents:
rds rds
regulatory regulatory
rxrpc rxrpc
sctp
.. only:: subproject and html .. only:: subproject and html
......
Linux Kernel SCTP .. SPDX-License-Identifier: GPL-2.0
=================
Linux Kernel SCTP
=================
This is the current BETA release of the Linux Kernel SCTP reference 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, SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
reliable transport protocol, with congestion control, support for reliable transport protocol, with congestion control, support for
transparent multi-homing, and multiple ordered streams of messages. transparent multi-homing, and multiple ordered streams of messages.
RFC2960 defines the core protocol. The IETF SIGTRAN working group originally RFC2960 defines the core protocol. The IETF SIGTRAN working group originally
developed the SCTP protocol and later handed the protocol over to the 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 Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
general purpose transport. general purpose transport.
See the IETF website (http://www.ietf.org) for further documents on SCTP. See the IETF website (http://www.ietf.org) for further documents on SCTP.
See http://www.ietf.org/rfc/rfc2960.txt See http://www.ietf.org/rfc/rfc2960.txt
The initial project goal is to create an Linux kernel reference implementation The initial project goal is to create an Linux kernel reference implementation
of SCTP that is RFC 2960 compliant and provides an programming interface 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 referred to as the UDP-style API of the Sockets Extensions for SCTP, as
proposed in IETF Internet-Drafts. proposed in IETF Internet-Drafts.
Caveats: Caveats
=======
-lksctp can be built as statically or as a module. However, be aware that - lksctp can be built as statically or as a module. However, be aware that
module removal of lksctp is not yet a safe activity. module removal of lksctp is not yet a safe activity.
-There is tentative support for IPv6, but most work has gone towards - There is tentative support for IPv6, but most work has gone towards
implementation and testing lksctp on IPv4. implementation and testing lksctp on IPv4.
For more information, please visit the lksctp project website: For more information, please visit the lksctp project website:
http://www.sf.net/projects/lksctp http://www.sf.net/projects/lksctp
Or contact the lksctp developers through the mailing list: Or contact the lksctp developers through the mailing list:
<linux-sctp@vger.kernel.org> <linux-sctp@vger.kernel.org>
...@@ -14999,7 +14999,7 @@ M: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com> ...@@ -14999,7 +14999,7 @@ M: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
L: linux-sctp@vger.kernel.org L: linux-sctp@vger.kernel.org
S: Maintained S: Maintained
W: http://lksctp.sourceforge.net W: http://lksctp.sourceforge.net
F: Documentation/networking/sctp.txt F: Documentation/networking/sctp.rst
F: include/linux/sctp.h F: include/linux/sctp.h
F: include/net/sctp/ F: include/net/sctp/
F: include/uapi/linux/sctp.h F: include/uapi/linux/sctp.h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment