From: Liam Beguin <liambeguin@gmail.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Linux Documentation <linux-doc@vger.kernel.org>,
Linux Kernel Build System <linux-kbuild@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>, Alex Shi <alexs@kernel.org>,
Yanteng Si <siyanteng@loongson.cn>,
Kees Cook <keescook@chromium.org>,
Akira Yokosawa <akiyks@gmail.com>,
Masahiro Yamada <masahiroy@kernel.org>,
Wu XiangCheng <bobwxc@email.cn>,
Luis Chamberlain <mcgrof@kernel.org>,
Binbin Zhou <zhoubinbin@loongson.cn>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH] Documentation: core-api: update kernel-doc reference to kmod.c
Date: Fri, 24 Mar 2023 10:40:03 -0400 [thread overview]
Message-ID: <20230324144003.GA2456286@shaak> (raw)
In-Reply-To: <20230324085310.20571-1-bagasdotme@gmail.com>
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
>
next prev parent reply other threads:[~2023-03-24 14:40 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2023-03-24 18:14 ` Luis Chamberlain
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230324144003.GA2456286@shaak \
--to=liambeguin@gmail.com \
--cc=akiyks@gmail.com \
--cc=alexs@kernel.org \
--cc=bagasdotme@gmail.com \
--cc=bobwxc@email.cn \
--cc=corbet@lwn.net \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=mcgrof@kernel.org \
--cc=sfr@canb.auug.org.au \
--cc=siyanteng@loongson.cn \
--cc=zhoubinbin@loongson.cn \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.