linux-kernel - Re: [PATCH] docs: fix 'make htmldocs' warning in SCTP.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CADvbK_f9G2-yTOd=n_0ywFjs15Cg9ZAqvzyQYjgxBCzFqDbeLw@mail.gmail.com>
Date:   Mon, 28 Feb 2022 11:13:25 +0800
From:   Xin Long <lucien.xin@...il.com>
To:     Wan Jiabing <wanjiabing@...o.com>
Cc:     Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Paul Moore <paul@...l-moore.com>,
        Richard Haines <richard_c_haines@...nternet.com>,
        Ondrej Mosnacek <omosnace@...hat.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        jiabing.wan@...com
Subject: Re: [PATCH] docs: fix 'make htmldocs' warning in SCTP.rst

On Mon, Feb 28, 2022 at 10:57 AM Wan Jiabing <wanjiabing@...o.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@...o.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 ``@...c->peer_secid`` for client::
>
> @@ -270,7 +270,7 @@ sockets sid and peer sid to that contained in the ``@...c sid`` and
>
>
>  security_sctp_assoc_established()
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  Called when a COOKIE ACK is received where it sets the connection's peer sid
>  to that in ``@...``::
>
> --
> 2.35.1
>
Reviewed-by: Xin Long <lucien.xin@...il.com>