[PATCH v2] entry: Update outdated comment in entry_common.h

Khalid Ali posted 1 patch 3 months, 3 weeks ago
include/linux/entry-common.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v2] entry: Update outdated comment in entry_common.h
Posted by Khalid Ali 3 months, 3 weeks ago
From: Khalid Ali <khaliidcaliy@gmail.com>

The comment above syscall_enter_from_user_mode() refers to
syscall_enter_from_user_mode_prepare(), which is no longer used. This can
mislead readers trying to follow the entry path.

Update the comment to reflect the current implementation by replacing
syscall_enter_from_user_mode_prepare() with enter_from_user_mode().

Signed-off-by: Khalid Ali <khaliidcaliy@gmail.com>
---
 include/linux/entry-common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/entry-common.h b/include/linux/entry-common.h
index dad1f257e3dd..49f5d99b254c 100644
--- a/include/linux/entry-common.h
+++ b/include/linux/entry-common.h
@@ -146,7 +146,7 @@ long syscall_trace_enter(struct pt_regs *regs, long syscall,
  * @syscall:	The syscall number
  *
  * Invoked from architecture specific syscall entry code with interrupts
- * enabled after invoking syscall_enter_from_user_mode_prepare() and extra
+ * enabled after invoking enter_from_user_mode() and extra
  * architecture specific work.
  *
  * Returns: The original or a modified syscall number
-- 
2.49.0
Re: [PATCH v2] entry: Update outdated comment in entry_common.h
Posted by Thomas Gleixner 3 months, 2 weeks ago
On Wed, Jun 18 2025 at 08:12, Khalid Ali wrote:

$Subject: entry: Update outdated kernel doc for syscall_trace_enter()

The shortlog should describe the change concisely. 'in entry_common.h'
tells absolutely nothing.

> From: Khalid Ali <khaliidcaliy@gmail.com>
>
> The comment above syscall_enter_from_user_mode() refers to
> syscall_enter_from_user_mode_prepare(), which is no longer used. This can
> mislead readers trying to follow the entry path.
>
> Update the comment to reflect the current implementation by replacing
> syscall_enter_from_user_mode_prepare() with enter_from_user_mode().
>
> Signed-off-by: Khalid Ali <khaliidcaliy@gmail.com>
> ---
>  include/linux/entry-common.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/entry-common.h b/include/linux/entry-common.h
> index dad1f257e3dd..49f5d99b254c 100644
> --- a/include/linux/entry-common.h
> +++ b/include/linux/entry-common.h
> @@ -146,7 +146,7 @@ long syscall_trace_enter(struct pt_regs *regs, long syscall,
>   * @syscall:	The syscall number
>   *
>   * Invoked from architecture specific syscall entry code with interrupts
> - * enabled after invoking syscall_enter_from_user_mode_prepare() and extra
> + * enabled after invoking enter_from_user_mode() and extra
>   * architecture specific work.

And how is that more correct? I explained it to you in great detail what
the prerequisites are:

 https://lore.kernel.org/all/87cyb6q1aj.ffs@tglx

No?

Thanks,

        tglx