From: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>,
Jakub Kicinski <kuba@kernel.org>,
Vlad Yasevich <vyasevich@gmail.com>,
Neil Horman <nhorman@tuxdriver.com>,
netdev@vger.kernel.org, linux-sctp@vger.kernel.org
Subject: Re: [PATCH 27/37] docs: networking: convert sctp.txt to ReST
Date: Thu, 30 Apr 2020 13:46:49 -0300 [thread overview]
Message-ID: <20200430164649.GB2470@localhost.localdomain> (raw)
In-Reply-To: <5bbbf00c3aba45253e9d6ba0efeaf34bf2a8450f.1588261997.git.mchehab+huawei@kernel.org>
On Thu, Apr 30, 2020 at 06:04:22PM +0200, Mauro Carvalho Chehab wrote:
> - 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 <mchehab+huawei@kernel.org>
Acked-by: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
> ---
> 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%)
>
> 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.txt b/Documentation/networking/sctp.rst
> similarity index 64%
> rename from Documentation/networking/sctp.txt
> rename to Documentation/networking/sctp.rst
> index 97b810ca9082..9f4d9c8a925b 100644
> --- a/Documentation/networking/sctp.txt
> +++ b/Documentation/networking/sctp.rst
> @@ -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:
> +
> <linux-sctp@vger.kernel.org>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 93e1b253ae51..64789b29c085 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -15044,7 +15044,7 @@ M: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
> 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
> --
> 2.25.4
>
next prev parent reply other threads:[~2020-04-30 16:46 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-30 16:03 [PATCH 00/37] net: manually convert files to ReST format - part 2 Mauro Carvalho Chehab
2020-04-30 16:03 ` [PATCH 01/37] docs: networking: convert l2tp.txt to ReST Mauro Carvalho Chehab
2020-04-30 16:03 ` [PATCH 02/37] docs: networking: convert lapb-module.txt " Mauro Carvalho Chehab
2020-04-30 16:03 ` [PATCH 03/37] docs: networking: convert ltpc.txt " Mauro Carvalho Chehab
2020-04-30 16:03 ` [PATCH 04/37] docs: networking: convert mac80211-injection.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 05/37] docs: networking: convert mpls-sysctl.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 06/37] docs: networking: convert multiqueue.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 07/37] docs: networking: convert netconsole.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 08/37] docs: networking: convert netdev-features.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 09/37] docs: networking: convert netdevices.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 10/37] docs: networking: convert netfilter-sysctl.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 11/37] docs: networking: convert netif-msg.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 12/37] docs: networking: convert nf_conntrack-sysctl.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 13/37] docs: networking: convert nf_flowtable.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 14/37] docs: networking: convert openvswitch.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 15/37] docs: networking: convert operstates.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 16/37] docs: networking: convert packet_mmap.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 17/37] docs: networking: convert phonet.txt " Mauro Carvalho Chehab
2020-04-30 18:46 ` Rémi Denis-Courmont
2020-04-30 16:04 ` [PATCH 18/37] docs: networking: convert pktgen.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 19/37] docs: networking: convert PLIP.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 20/37] docs: networking: convert ppp_generic.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 21/37] docs: networking: convert proc_net_tcp.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 22/37] docs: networking: convert radiotap-headers.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 23/37] docs: networking: convert ray_cs.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 24/37] docs: networking: convert rds.txt " Mauro Carvalho Chehab
2020-04-30 16:08 ` santosh.shilimkar
2020-04-30 16:04 ` [PATCH 25/37] docs: networking: convert regulatory.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 26/37] docs: networking: convert rxrpc.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 27/37] docs: networking: convert sctp.txt " Mauro Carvalho Chehab
2020-04-30 16:46 ` Marcelo Ricardo Leitner [this message]
2020-04-30 16:04 ` [PATCH 28/37] docs: networking: convert secid.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 29/37] docs: networking: convert seg6-sysctl.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 30/37] docs: networking: convert skfp.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 31/37] docs: networking: convert strparser.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 32/37] docs: networking: convert switchdev.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 33/37] docs: networking: convert tc-actions-env-rules.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 34/37] docs: networking: convert tcp-thin.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 35/37] docs: networking: convert team.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 36/37] docs: networking: convert timestamping.txt " Mauro Carvalho Chehab
2020-04-30 16:04 ` [PATCH 37/37] docs: networking: convert tproxy.txt " Mauro Carvalho Chehab
2020-04-30 19:56 ` [PATCH 00/37] net: manually convert files to ReST format - part 2 David Miller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200430164649.GB2470@localhost.localdomain \
--to=marcelo.leitner@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sctp@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=nhorman@tuxdriver.com \
--cc=vyasevich@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).