linux-kernel - Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix kernel-doc references after code split-up preparation

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <ZEN0MsKMQXTqGwk-@kroah.com>
Date:   Sat, 22 Apr 2023 07:44:18 +0200
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     Salvatore Bonaccorso <carnil@...ian.org>
Cc:     stable <stable@...r.kernel.org>, Sasha Levin <sashal@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        André Almeida <andrealmeid@...labora.com>,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH v2 stable-5.10.y stable-5.15.y] docs: futex: Fix
 kernel-doc references after code split-up preparation

On Sat, Apr 22, 2023 at 12:17:42AM +0200, Salvatore Bonaccorso wrote:
> In upstream commit 77e52ae35463 ("futex: Move to kernel/futex/") the
> futex code from kernel/futex.c was moved into kernel/futex/core.c in
> preparation of the split-up of the implementation in various files.
> 
> Point kernel-doc references to the new files as otherwise the
> documentation shows errors on build:
> 
>     [...]
>     Error: Cannot open file ./kernel/futex.c
>     Error: Cannot open file ./kernel/futex.c
>     [...]
>     WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 3.4.3 -internal ./kernel/futex.c' failed with return code 2
> 
> There is no direct upstream commit for this change. It is made in
> analogy to commit bc67f1c454fb ("docs: futex: Fix kernel-doc
> references") applied as consequence of the restructuring of the futex
> code.
> 
> Fixes: 77e52ae35463 ("futex: Move to kernel/futex/")
> Signed-off-by: Salvatore Bonaccorso <carnil@...ian.org>
> ---
> v1->v2:
>  - Fix typo in description about new target file for futex.c code
>  - Indent block with build log output
> 
>  Documentation/kernel-hacking/locking.rst                    | 2 +-
>  Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)

<formletter>

This is not the correct way to submit patches for inclusion in the
stable kernel tree.  Please read:
    https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
for how to do this properly.

</formletter>