2022-02-28 06:53:12

by Xin Long

[permalink] [raw]
Subject: Re: [PATCH] docs: fix 'make htmldocs' warning in SCTP.rst

On Mon, Feb 28, 2022 at 10:57 AM Wan Jiabing <[email protected]> wrote:
>
> Fix following 'make htmldocs' warnings:
> ./Documentation/security/SCTP.rst:123: WARNING: Title underline too short.
> security_sctp_assoc_established()
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> ./Documentation/security/SCTP.rst:123: WARNING: Title underline too short.
> security_sctp_assoc_established()
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> ./Documentation/security/SCTP.rst:273: WARNING: Title underline too short.
> security_sctp_assoc_established()
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> ./Documentation/security/SCTP.rst:273: WARNING: Title underline too short.
> security_sctp_assoc_established()
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Fixes: 5e50f5d4ff31 ("security: add sctp_assoc_established hook")
> Signed-off-by: Wan Jiabing <[email protected]>
> ---
> Documentation/security/SCTP.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/security/SCTP.rst b/Documentation/security/SCTP.rst
> index 406cc68b8808..b73eb764a001 100644
> --- a/Documentation/security/SCTP.rst
> +++ b/Documentation/security/SCTP.rst
> @@ -120,7 +120,7 @@ calls **sctp_peeloff**\(3).
>
>
> security_sctp_assoc_established()
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> Called when a COOKIE ACK is received, and the peer secid will be
> saved into ``@asoc->peer_secid`` for client::
>
> @@ -270,7 +270,7 @@ sockets sid and peer sid to that contained in the ``@asoc sid`` and
>
>
> security_sctp_assoc_established()
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> Called when a COOKIE ACK is received where it sets the connection's peer sid
> to that in ``@skb``::
>
> --
> 2.35.1
>
Reviewed-by: Xin Long <[email protected]>