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

2023-03-24 08:55:29

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

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 <[email protected]>
Link: https://lore.kernel.org/linux-next/[email protected]/
Signed-off-by: Bagas Sanjaya <[email protected]>
---
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

2023-03-24 14:43:46

by Liam Beguin

[permalink] [raw]

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 <[email protected]>
> Link: https://lore.kernel.org/linux-next/[email protected]/
> Signed-off-by: Bagas Sanjaya <[email protected]>

Reviewed-by: Liam Beguin <[email protected]>

> ---
> 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
>

2023-03-24 18:23:40

by Luis Chamberlain

[permalink] [raw]