linux-kernel - Re: [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c

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: <20230324144003.GA2456286@shaak>
Date:   Fri, 24 Mar 2023 10:40:03 -0400
From:   Liam Beguin <liambeguin@...il.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Linux Documentation <linux-doc@...r.kernel.org>,
        Linux Kernel Build System <linux-kbuild@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>, Alex Shi <alexs@...nel.org>,
        Yanteng Si <siyanteng@...ngson.cn>,
        Kees Cook <keescook@...omium.org>,
        Akira Yokosawa <akiyks@...il.com>,
        Masahiro Yamada <masahiroy@...nel.org>,
        Wu XiangCheng <bobwxc@...il.cn>,
        Luis Chamberlain <mcgrof@...nel.org>,
        Binbin Zhou <zhoubinbin@...ngson.cn>,
        Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH] Documentation: core-api: update kernel-doc reference to
 kmod.c

On Fri, Mar 24, 2023 at 03:53:10PM +0700, Bagas Sanjaya wrote:
> Commit d6f819908f8aac ("module: fold usermode helper kmod into modules
> directory") moves kmod helper implementation (kmod.c) to kernel/module/
> directory but forgets to update its reference on kernel api doc, hence:
> 
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 2.4.4 -export ./kernel/kmod.c' failed with return code 2
> 
> Update the reference.
> 
> Fixes: d6f819908f8aac ("module: fold usermode helper kmod into modules directory")
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Link: https://lore.kernel.org/linux-next/20230324154413.19cc78be@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Reviewed-by: Liam Beguin <liambeguin@...il.com>

> ---
>  Documentation/core-api/kernel-api.rst                    | 2 +-
>  Documentation/translations/zh_CN/core-api/kernel-api.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
> index 62f961610773d6..e2772859600801 100644
> --- a/Documentation/core-api/kernel-api.rst
> +++ b/Documentation/core-api/kernel-api.rst
> @@ -223,7 +223,7 @@ Module Support
>  Module Loading
>  --------------
>  
> -.. kernel-doc:: kernel/kmod.c
> +.. kernel-doc:: kernel/module/kmod.c
>     :export:
>  
>  Inter Module support
> diff --git a/Documentation/translations/zh_CN/core-api/kernel-api.rst b/Documentation/translations/zh_CN/core-api/kernel-api.rst
> index a4b373c48c0c9b..a1ea7081077cee 100644
> --- a/Documentation/translations/zh_CN/core-api/kernel-api.rst
> +++ b/Documentation/translations/zh_CN/core-api/kernel-api.rst
> @@ -226,7 +226,7 @@ kernel/relay.c
>  
>  该API在以下内核代码中:
>  
> -kernel/kmod.c
> +kernel/module/kmod.c
>  
>  模块接口支持
>  ------------
> 
> base-commit: 6e82310365bade624ff38dd11a8467739adab6cc
> -- 
> An old man doll... just what I always wanted! - Clara
>