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] [day] [month] [year] [list]

Message-ID: <ZEOGeVyvOx6/xypo@eldamar.lan>
Date:   Sat, 22 Apr 2023 09:02:17 +0200
From:   Salvatore Bonaccorso <carnil@...ian.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     stable <stable@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.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

Hi Randy,

On Fri, Apr 21, 2023 at 05:03:15PM -0700, Randy Dunlap wrote:
> Please see https://lore.kernel.org/all/20211012135549.14451-1-andrealmeid@collabora.com/
> 
> Don't know what has happened to it though.  :(

It was applied, as bc67f1c454fb ("docs: futex: Fix kernel-doc
references") in 5.16-rc1. But 5.10.y and 5.15.y picked up from the
refactoring only 77e52ae35463 ("futex: Move to kernel/futex/"). 

So this change is a specific backport of subset of it, to 5.10.y and
5.15.y thus the commit message:

> On 4/21/23 15:17, 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.

Here pointing out explicitly that there is no (direct) upstream commit
for it. 

Hope this helps,

Regards,
Salvatore