Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20220228025646.1665265-1-wanjiabing@vivo.com>
In-Reply-To: <20220228025646.1665265-1-wanjiabing@vivo.com>
From:   Xin Long <lucien.xin@gmail.com>
Date:   Mon, 28 Feb 2022 11:13:25 +0800
Message-ID: <CADvbK_f9G2-yTOd=n_0ywFjs15Cg9ZAqvzyQYjgxBCzFqDbeLw@mail.gmail.com>
Subject: Re: [PATCH] docs: fix 'make htmldocs' warning in SCTP.rst
To:     Wan Jiabing <wanjiabing@vivo.com>
Cc:     Jonathan Corbet <corbet@lwn.net>,
        "David S. Miller" <davem@davemloft.net>,
        Paul Moore <paul@paul-moore.com>,
        Richard Haines <richard_c_haines@btinternet.com>,
        Ondrej Mosnacek <omosnace@redhat.com>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        jiabing.wan@qq.com
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Feb 28, 2022 at 10:57 AM Wan Jiabing <wanjiabing@vivo.com> 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 <wanjiabing@vivo.com>
> ---
>  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 <lucien.xin@gmail.com>