2021-06-08 02:47:46

by Baokun Li

Subject: [PATCH -next] x86/power: fix doc warnings in cpu.c

Fixes the following W=1 kernel build warning(s):

arch/x86/power/cpu.c:76: warning: Function parameter or
member 'ctxt' not described in '__save_processor_state'
arch/x86/power/cpu.c:192: warning: Function parameter or
member 'ctxt' not described in '__restore_processor_state'

Signed-off-by: Baokun Li <[email protected]>
---
arch/x86/power/cpu.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
index 3a070e7cdb8b..2640b9128479 100644
--- a/arch/x86/power/cpu.c
+++ b/arch/x86/power/cpu.c
@@ -60,7 +60,7 @@ static void msr_restore_context(struct saved_context *ctxt)
/**
* __save_processor_state - save CPU registers before creating a
* hibernation image and before restoring the memory state from it
- * @ctxt - structure to store the registers contents in
+ * @ctxt: structure to store the registers contents in
*
* NOTE: If there is a CPU register the modification of which by the
* boot kernel (ie. the kernel used for loading the hibernation image)
@@ -183,7 +183,7 @@ static void fix_processor_context(void)
/**
* __restore_processor_state - restore the contents of CPU registers saved
* by __save_processor_state()
- * @ctxt - structure to load the registers contents from
+ * @ctxt: structure to load the registers contents from
*
* The asm code that gets us here will have restored a usable GDT, although
* it will be pointing to the wrong alias.
--
2.31.1

2021-06-11 16:51:22

by Rafael J. Wysocki

Subject: Re: [PATCH -next] x86/power: fix doc warnings in cpu.c

On Tue, Jun 8, 2021 at 4:45 AM Baokun Li <[email protected]> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> arch/x86/power/cpu.c:76: warning: Function parameter or
> member 'ctxt' not described in '__save_processor_state'
> arch/x86/power/cpu.c:192: warning: Function parameter or
> member 'ctxt' not described in '__restore_processor_state'
>
> Signed-off-by: Baokun Li <[email protected]>
> ---
> arch/x86/power/cpu.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
> index 3a070e7cdb8b..2640b9128479 100644
> --- a/arch/x86/power/cpu.c
> +++ b/arch/x86/power/cpu.c
> @@ -60,7 +60,7 @@ static void msr_restore_context(struct saved_context *ctxt)
> /**
> * __save_processor_state - save CPU registers before creating a
> * hibernation image and before restoring the memory state from it
> - * @ctxt - structure to store the registers contents in
> + * @ctxt: structure to store the registers contents in

Any chance to fix the formatting of this kerneldoc comment too in this patch?

> *
> * NOTE: If there is a CPU register the modification of which by the
> * boot kernel (ie. the kernel used for loading the hibernation image)
> @@ -183,7 +183,7 @@ static void fix_processor_context(void)
> /**
> * __restore_processor_state - restore the contents of CPU registers saved
> * by __save_processor_state()
> - * @ctxt - structure to load the registers contents from
> + * @ctxt: structure to load the registers contents from
> *
> * The asm code that gets us here will have restored a usable GDT, although
> * it will be pointing to the wrong alias.
> --
> 2.31.1
>