PM: hibernate: fix the kerneldoc comment for swsusp_check() and swsusp_close()
authorChristoph Hellwig <hch@lst.de>
Mon, 25 Sep 2023 07:40:58 +0000 (09:40 +0200)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tue, 26 Sep 2023 18:25:46 +0000 (20:25 +0200)
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>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
kernel/power/swap.c

index 74edbce2320bae543c522b97301ec9719725cfa1..a64af0a552f9661a6b20a9b05dac41813262586f 100644 (file)
@@ -1513,7 +1513,7 @@ end:
 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.
  */
 
@@ -1564,7 +1564,7 @@ put:
 }
 
 /**
- * swsusp_close - close swap device.
+ * swsusp_close - close resume device.
  * @exclusive: Close the resume device which is exclusively opened.
  */