Skip to content

Commit afc880c

Browse files
LiBaokun96suryasaimadhu
authored andcommitted
x86/power: Fix kernel-doc warnings in cpu.c
Fixes the following kernel-doc warnings: 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]> Signed-off-by: Borislav Petkov <[email protected]> Link: https://lkml.kernel.org/r/[email protected]
1 parent 8ae9e3f commit afc880c

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

arch/x86/power/cpu.c

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,19 +58,20 @@ static void msr_restore_context(struct saved_context *ctxt)
5858
}
5959

6060
/**
61-
* __save_processor_state - save CPU registers before creating a
62-
* hibernation image and before restoring the memory state from it
63-
* @ctxt - structure to store the registers contents in
61+
* __save_processor_state() - Save CPU registers before creating a
62+
* hibernation image and before restoring
63+
* the memory state from it
64+
* @ctxt: Structure to store the registers contents in.
6465
*
65-
* NOTE: If there is a CPU register the modification of which by the
66-
* boot kernel (ie. the kernel used for loading the hibernation image)
67-
* might affect the operations of the restored target kernel (ie. the one
68-
* saved in the hibernation image), then its contents must be saved by this
69-
* function. In other words, if kernel A is hibernated and different
70-
* kernel B is used for loading the hibernation image into memory, the
71-
* kernel A's __save_processor_state() function must save all registers
72-
* needed by kernel A, so that it can operate correctly after the resume
73-
* regardless of what kernel B does in the meantime.
66+
* NOTE: If there is a CPU register the modification of which by the
67+
* boot kernel (ie. the kernel used for loading the hibernation image)
68+
* might affect the operations of the restored target kernel (ie. the one
69+
* saved in the hibernation image), then its contents must be saved by this
70+
* function. In other words, if kernel A is hibernated and different
71+
* kernel B is used for loading the hibernation image into memory, the
72+
* kernel A's __save_processor_state() function must save all registers
73+
* needed by kernel A, so that it can operate correctly after the resume
74+
* regardless of what kernel B does in the meantime.
7475
*/
7576
static void __save_processor_state(struct saved_context *ctxt)
7677
{
@@ -181,9 +182,9 @@ static void fix_processor_context(void)
181182
}
182183

183184
/**
184-
* __restore_processor_state - restore the contents of CPU registers saved
185-
* by __save_processor_state()
186-
* @ctxt - structure to load the registers contents from
185+
* __restore_processor_state() - Restore the contents of CPU registers saved
186+
* by __save_processor_state()
187+
* @ctxt: Structure to load the registers contents from.
187188
*
188189
* The asm code that gets us here will have restored a usable GDT, although
189190
* it will be pointing to the wrong alias.

0 commit comments

Comments
 (0)