Re: [PATCH v12 2/3] mm: memory-failure: move return value documentation to function declaration

[Shuai Xue]

在 2024/9/4 00:10, Jarkko Sakkinen 写道:
> On Mon Sep 2, 2024 at 6:00 AM EEST, Shuai Xue wrote:
> > Part of return value comments for memory_failure() were originally
> > documented at the call site. Move those comments to the function
> > declaration to improve code readability and to provide developers with
> > immediate access to function usage and return information.
> >
> > Signed-off-by: Shuai Xue <xueshuai@xxxxxxxxxxxxxxxxx>
> > ---
> >   arch/x86/kernel/cpu/mce/core.c | 7 -------
> >   mm/memory-failure.c            | 9 ++++++---
> >   2 files changed, 6 insertions(+), 10 deletions(-)
> >
> > diff --git a/arch/x86/kernel/cpu/mce/core.c b/arch/x86/kernel/cpu/mce/core.c
> > index b85ec7a4ec9e..66693b6dd1cd 100644
> > --- a/arch/x86/kernel/cpu/mce/core.c
> > +++ b/arch/x86/kernel/cpu/mce/core.c
> > @@ -1361,13 +1361,6 @@ static void kill_me_maybe(struct callback_head *cb)
> >   		return;
> >   	}
> >   
> > -	/*
> > -	 * -EHWPOISON from memory_failure() means that it already sent SIGBUS
> > -	 * to the current process with the proper error info,
> > -	 * -EOPNOTSUPP means hwpoison_filter() filtered the error event,
> > -	 *
> > -	 * In both cases, no further processing is required.
> > -	 */
> >   	if (ret == -EHWPOISON || ret == -EOPNOTSUPP)
> >   		return;
> >   
> > diff --git a/mm/memory-failure.c b/mm/memory-failure.c
> > index 7066fc84f351..df26e2ff5e06 100644
> > --- a/mm/memory-failure.c
> > +++ b/mm/memory-failure.c
> > @@ -2199,9 +2199,12 @@ static void kill_procs_now(struct page *p, unsigned long pfn, int flags,
> >    * Must run in process context (e.g. a work queue) with interrupts
> >    * enabled and no spinlocks held.
> >    *
> > - * Return: 0 for successfully handled the memory error,
> > - *         -EOPNOTSUPP for hwpoison_filter() filtered the error event,
> > - *         < 0(except -EOPNOTSUPP) on failure.
> > + * Return values:
>
> s/Return values/Return:/
>
> https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt

Hi, Jarkko,

Thank you for the reminder. Will fix it in next version.

Best Regards,
Shuai