]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
PM: sleep: convert comment from kernel-doc to plain comment
authorRandy Dunlap <rdunlap@infradead.org>
Sat, 11 Jan 2025 06:31:07 +0000 (22:31 -0800)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tue, 14 Jan 2025 20:14:19 +0000 (21:14 +0100)
Modify a non-kernel-doc comment to begin with /* instead of /**
so that it does not cause a kernel-doc warning.

power.h:114: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 *      Auxiliary structure used for reading the snapshot image data and
power.h:114: warning: missing initial short description on line:
 *      Auxiliary structure used for reading the snapshot image data and

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Pavel Machek <pavel@ucw.cz>
Link: https://patch.msgid.link/20250111063107.910825-1-rdunlap@infradead.org
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
kernel/power/power.h

index de0e6b1077f231dc97896e31b7ce9e8204583641..c352dea2f67b56fb4ceae4500a8b67e51a465669 100644 (file)
@@ -110,7 +110,7 @@ extern int hibernate_preallocate_memory(void);
 
 extern void clear_or_poison_free_pages(void);
 
-/**
+/*
  *     Auxiliary structure used for reading the snapshot image data and
  *     metadata from and writing them to the list of page backup entries
  *     (PBEs) which is the main data structure of swsusp.