| Message ID | 20230925074058.149779-1-hch@lst.de (mailing list archive) |
|---|---|
| State | Mainlined, archived |
| Headers | show |
| Series | PM: hibernate: fix the kerneldoc comment for swsusp_check and swsusp_close | expand |
On Mon, Sep 25, 2023 at 9:41 AM Christoph Hellwig <hch@lst.de> wrote: > > The comments for both swsusp_check and swsusp_close don't actually > describe what they are doing. > > Just removing the comments would probably better, but as the file is > full of useless kerneldoc comments for non-exported symbols this fits > in better with the style. > > Signed-off-by: Christoph Hellwig <hch@lst.de> > --- > kernel/power/swap.c | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/kernel/power/swap.c b/kernel/power/swap.c > index 48ec6a8ef9c445..b9763f2f632b8a 100644 > --- a/kernel/power/swap.c > +++ b/kernel/power/swap.c > @@ -1513,7 +1513,7 @@ int swsusp_read(unsigned int *flags_p) > static void *swsusp_holder; > > /** > - * swsusp_check - Check for swsusp signature in the resume device > + * swsusp_check - Open the resume device and check for the swsusp signature. > * @exclusive: Open the resume device exclusively. > */ > > @@ -1567,7 +1567,7 @@ int swsusp_check(bool exclusive) > } > > /** > - * swsusp_close - close swap device. > + * swsusp_close - close resume device. > * @exclusive: Close the resume device which is exclusively opened. > */ > > -- Applied as 6.7 material, thanks!
diff --git a/kernel/power/swap.c b/kernel/power/swap.c index 48ec6a8ef9c445..b9763f2f632b8a 100644 --- a/kernel/power/swap.c +++ b/kernel/power/swap.c @@ -1513,7 +1513,7 @@ int swsusp_read(unsigned int *flags_p) static void *swsusp_holder; /** - * swsusp_check - Check for swsusp signature in the resume device + * swsusp_check - Open the resume device and check for the swsusp signature. * @exclusive: Open the resume device exclusively. */ @@ -1567,7 +1567,7 @@ int swsusp_check(bool exclusive) } /** - * swsusp_close - close swap device. + * swsusp_close - close resume device. * @exclusive: Close the resume device which is exclusively opened. */
The comments for both swsusp_check and swsusp_close don't actually describe what they are doing. Just removing the comments would probably better, but as the file is full of useless kerneldoc comments for non-exported symbols this fits in better with the style. Signed-off-by: Christoph Hellwig <hch@lst.de> --- kernel/power/swap.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)