l2tp: cleanup comments
authorTom Parkin <tparkin@katalix.com>
Wed, 22 Jul 2020 16:32:06 +0000 (17:32 +0100)
committerDavid S. Miller <davem@davemloft.net>
Thu, 23 Jul 2020 01:08:39 +0000 (18:08 -0700)
commit20dcb1107ab1a3423c72a88269b9775cc549262a
treef64cebd489d7eb4148c48e7cfa894bddc30b637e
parentb71a61ccfebb4ff733d2d9fc66cd5c75b7ae46a2
l2tp: cleanup comments

Modify some l2tp comments to better adhere to kernel coding style, as
reported by checkpatch.pl.

Add descriptive comments for the l2tp per-net spinlocks to document
their use.

Fix an incorrect comment in l2tp_recv_common:

RFC2661 section 5.4 states that:

"The LNS controls enabling and disabling of sequence numbers by sending a
data message with or without sequence numbers present at any time during
the life of a session."

l2tp handles this correctly in l2tp_recv_common, but the comment around
the code was incorrect and confusing.  Fix up the comment accordingly.

Signed-off-by: Tom Parkin <tparkin@katalix.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
net/l2tp/l2tp_core.c
net/l2tp/l2tp_core.h
net/l2tp/l2tp_debugfs.c
net/l2tp/l2tp_eth.c
net/l2tp/l2tp_ip.c
net/l2tp/l2tp_ip6.c
net/l2tp/l2tp_netlink.c
net/l2tp/l2tp_ppp.c