diff mbox series

Documentation: core-api: update kernel-doc reference to kmod.c

Message ID 20230324085310.20571-1-bagasdotme@gmail.com
State New
Headers
Series Documentation: core-api: update kernel-doc reference to kmod.c |

Commit Message

Bagas Sanjaya March 24, 2023, 8:53 a.m. UTC 
  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(-)


base-commit: 6e82310365bade624ff38dd11a8467739adab6cc

Comments

Liam Beguin March 24, 2023, 2:40 p.m. UTC | #1 
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
>
Luis Chamberlain March 24, 2023, 6:14 p.m. UTC | #2 
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
diff mbox series

Patch

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
 
 模块接口支持
 ------------