* [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c
@ 2023-03-24 8:53 Bagas Sanjaya
2023-03-24 14:40 ` Liam Beguin
2023-03-24 18:14 ` Luis Chamberlain
0 siblings, 2 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2023-03-24 8:53 UTC (permalink / raw)
To: Linux Documentation, Linux Kernel Build System,
Linux Kernel Mailing List
Cc: Jonathan Corbet, Alex Shi, Yanteng Si, Kees Cook, Bagas Sanjaya,
Akira Yokosawa, Masahiro Yamada, Liam Beguin, Wu XiangCheng,
Luis Chamberlain, Binbin Zhou, Stephen Rothwell
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@canb.auug.org.au>
Link: https://lore.kernel.org/linux-next/20230324154413.19cc78be@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c
2023-03-24 8:53 [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c Bagas Sanjaya
@ 2023-03-24 14:40 ` Liam Beguin
2023-03-24 18:14 ` Luis Chamberlain
1 sibling, 0 replies; 3+ messages in thread
From: Liam Beguin @ 2023-03-24 14:40 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Documentation, Linux Kernel Build System,
Linux Kernel Mailing List, Jonathan Corbet, Alex Shi, Yanteng Si,
Kees Cook, Akira Yokosawa, Masahiro Yamada, Wu XiangCheng,
Luis Chamberlain, Binbin Zhou, Stephen Rothwell
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@canb.auug.org.au>
> Link: https://lore.kernel.org/linux-next/20230324154413.19cc78be@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Liam Beguin <liambeguin@gmail.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
>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c
2023-03-24 8:53 [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c Bagas Sanjaya
2023-03-24 14:40 ` Liam Beguin
@ 2023-03-24 18:14 ` Luis Chamberlain
1 sibling, 0 replies; 3+ messages in thread
From: Luis Chamberlain @ 2023-03-24 18:14 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Documentation, Linux Kernel Build System,
Linux Kernel Mailing List, Jonathan Corbet, Alex Shi, Yanteng Si,
Kees Cook, Akira Yokosawa, Masahiro Yamada, Liam Beguin,
Wu XiangCheng, Binbin Zhou, Stephen Rothwell
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@canb.auug.org.au>
> Link: https://lore.kernel.org/linux-next/20230324154413.19cc78be@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
Thanks, queued onto modules-next.
Luis
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-03-24 18:15 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-03-24 8:53 [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c Bagas Sanjaya
2023-03-24 14:40 ` Liam Beguin
2023-03-24 18:14 ` Luis Chamberlain
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox