linux-kernel - Re: [PATCH] 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] [day] [month] [year] [list]

Date:   Fri, 21 Apr 2023 17:02:58 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Salvatore Bonaccorso <carnil@...ian.org>,
        stable <stable@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Sasha Levin <sashal@...nel.org>
Cc:     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] docs: futex: Fix kernel-doc references after code
 split-up preparation

Please see https://lore.kernel.org/all/20211012135549.14451-1-andrealmeid@collabora.com/

Don't know what has happened to it though.  :(


On 4/21/23 14:05, 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 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>
> ---
>  Documentation/kernel-hacking/locking.rst                    | 2 +-
>  Documentation/translations/it_IT/kernel-hacking/locking.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
> index 6ed806e6061b..a6d89efede79 100644
> --- a/Documentation/kernel-hacking/locking.rst
> +++ b/Documentation/kernel-hacking/locking.rst
> @@ -1358,7 +1358,7 @@ Mutex API reference
>  Futex API reference
>  ===================
>  
> -.. kernel-doc:: kernel/futex.c
> +.. kernel-doc:: kernel/futex/core.c
>     :internal:
>  
>  Further reading
> diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
> index bf1acd6204ef..192ab8e28125 100644
> --- a/Documentation/translations/it_IT/kernel-hacking/locking.rst
> +++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst
> @@ -1400,7 +1400,7 @@ Riferimento per l'API dei Mutex
>  Riferimento per l'API dei Futex
>  ===============================
>  
> -.. kernel-doc:: kernel/futex.c
> +.. kernel-doc:: kernel/futex/core.c
>     :internal:
>  
>  Approfondimenti

-- 
~Randy